refactoring twig types to allow custom variables

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateCompletionContributor.java

@@ -33,6 +33,7 @@
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigExtensionParser;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigTypeResolveUtil;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigTypeContainer;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.collector.ControllerDocVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.translation.TranslationIndex;
 import fr.adrienbrault.idea.symfony2plugin.translation.TranslatorLookupElement;
@@ -453,16 +454,16 @@ protected void addCompletions(@NotNull CompletionParameters parameters, Processi
  String[] possibleTypes = TwigTypeResolveUtil.formatPsiTypeName(psiElement);
 
  // find core function for that
- for(PhpNamedElement phpNamedElement: TwigTypeResolveUtil.resolveTwigMethodName(psiElement, possibleTypes)) {
- if(phpNamedElement instanceof PhpClass) {
+ for(TwigTypeContainer twigTypeContainer: TwigTypeResolveUtil.resolveTwigMethodName(psiElement, possibleTypes)) {
+ if(twigTypeContainer.getPhpNamedElement() instanceof PhpClass) {
 
- for(Method method: ((PhpClass) phpNamedElement).getMethods()) {
+ for(Method method: ((PhpClass) twigTypeContainer.getPhpNamedElement()).getMethods()) {
  if(!(!method.getModifier().isPublic() || method.getName().startsWith("set") || method.getName().startsWith("__"))) {
  resultSet.addElement(new PhpTwigMethodLookupElement(method));
  }
  }
 
- for(Field field: ((PhpClass) phpNamedElement).getFields()) {
+ for(Field field: ((PhpClass) twigTypeContainer.getPhpNamedElement()).getFields()) {
  if(field.getModifier().isPublic()) {
  resultSet.addElement(new PhpTwigMethodLookupElement(field));
  }

src/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateGoToLocalDeclarationHandler.java

@@ -22,6 +22,7 @@
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigExtensionParser;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigTypeResolveUtil;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigTypeContainer;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.collector.ControllerDocVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.RegexPsiElementFilter;
@@ -98,12 +99,20 @@ private PsiElement[] getTypeGoto(PsiElement psiElement) {
  // click on first item is our class name
  String[] beforeLeaf = TwigTypeResolveUtil.formatPsiTypeName(psiElement);
  if(beforeLeaf.length == 0) {
- targetPsiElements.addAll(TwigTypeResolveUtil.resolveTwigMethodName(psiElement, TwigTypeResolveUtil.formatPsiTypeName(psiElement, true)));
+ Collection<TwigTypeContainer> twigTypeContainers = TwigTypeResolveUtil.resolveTwigMethodName(psiElement, TwigTypeResolveUtil.formatPsiTypeName(psiElement, true));
+ for(TwigTypeContainer twigTypeContainer: twigTypeContainers) {
+ if(twigTypeContainer.getPhpNamedElement() != null) {
+ targetPsiElements.add(twigTypeContainer.getPhpNamedElement());
+ }
+ }
+
  } else {
- Collection<? extends PhpNamedElement> types = TwigTypeResolveUtil.resolveTwigMethodName(psiElement, beforeLeaf);
+ Collection<TwigTypeContainer> types = TwigTypeResolveUtil.resolveTwigMethodName(psiElement, beforeLeaf);
  // provide method / field goto
- for(PhpNamedElement psiTarget: types) {
- targetPsiElements.addAll(TwigTypeResolveUtil.getTwigPhpNameTargets(psiTarget, psiElement.getText()));
+ for(TwigTypeContainer twigTypeContainer: types) {
+ if(twigTypeContainer.getPhpNamedElement() != null) {
+ targetPsiElements.addAll(TwigTypeResolveUtil.getTwigPhpNameTargets(twigTypeContainer.getPhpNamedElement(), psiElement.getText()));
+ }
  }
  }
 

src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigTypeResolveUtil.java

@@ -20,11 +20,13 @@
 import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollector;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigFileVariableCollectorParameter;
+import fr.adrienbrault.idea.symfony2plugin.templating.variable.TwigTypeContainer;
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.collector.*;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.*;
 import java.util.regex.Matcher;
@@ -71,18 +73,18 @@ public static String[] formatPsiTypeName(PsiElement psiElement) {
  return possibleTypes;
  }
 
- public static Collection<? extends PhpNamedElement> resolveTwigMethodName(PsiElement psiElement, String[] typeName) {
+ public static Collection<TwigTypeContainer> resolveTwigMethodName(PsiElement psiElement, String[] typeName) {
 
  if(typeName.length == 0) {
  return Collections.emptyList();
  }
 
  Collection<? extends PhpNamedElement> rootVariable = getRootVariableByName(psiElement, typeName[0]);
  if(typeName.length == 1) {
- return rootVariable;
+ return TwigTypeContainer.fromCollection(rootVariable);
  }
 
- Collection<? extends PhpNamedElement> type = rootVariable;
+ Collection<TwigTypeContainer> type = TwigTypeContainer.fromCollection(rootVariable);
  for (int i = 1; i <= typeName.length - 1; i++ ) {
  type = resolveTwigMethodName(type, typeName[i]);
 
@@ -93,7 +95,7 @@ public static Collection<? extends PhpNamedElement> resolveTwigMethodName(PsiEle
 
  }
 
- return type;
+ return TwigTypeContainer.fromCollection(rootVariable);
  }
 
  /**
@@ -250,20 +252,24 @@ private static Collection<? extends PhpNamedElement> getRootVariableByName(PsiEl
 
  }
 
- private static Collection<? extends PhpNamedElement> resolveTwigMethodName(Collection<? extends PhpNamedElement> previousElement, String typeName) {
+ private static Collection<TwigTypeContainer> resolveTwigMethodName(Collection<TwigTypeContainer> previousElement, String typeName) {
 
- ArrayList<PhpNamedElement> phpNamedElements = new ArrayList<PhpNamedElement>();
+ ArrayList<TwigTypeContainer> phpNamedElements = new ArrayList<TwigTypeContainer>();
+
+ for(TwigTypeContainer phpNamedElement: previousElement) {
 
- for(PhpNamedElement phpNamedElement: previousElement) {
- for(PhpNamedElement target : getTwigPhpNameTargets(phpNamedElement, typeName)) {
- PhpType phpType = target.getType();
- for(String typeString: phpType.getTypes()) {
- PhpNamedElement phpNamedElement1 = PhpElementsUtil.getClassInterface(phpNamedElement.getProject(), typeString);
- if(phpNamedElement1 != null) {
- phpNamedElements.add(phpNamedElement1);
+ if(phpNamedElement.getPhpNamedElement() != null) {
+ for(PhpNamedElement target : getTwigPhpNameTargets(phpNamedElement.getPhpNamedElement(), typeName)) {
+ PhpType phpType = target.getType();
+ for(String typeString: phpType.getTypes()) {
+ PhpNamedElement phpNamedElement1 = PhpElementsUtil.getClassInterface(phpNamedElement.getPhpNamedElement().getProject(), typeString);
+ if(phpNamedElement1 != null) {
+ phpNamedElements.add(new TwigTypeContainer(phpNamedElement1));
+ }
  }
  }
  }
+
  }
 
  return phpNamedElements;

src/fr/adrienbrault/idea/symfony2plugin/templating/variable/TwigTypeContainer.java

@@ -0,0 +1,45 @@
+package fr.adrienbrault.idea.symfony2plugin.templating.variable;
+
+import com.jetbrains.php.lang.psi.elements.PhpNamedElement;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+public class TwigTypeContainer {
+
+ private PhpNamedElement phpNamedElement;
+ private String stringElement;
+
+ public TwigTypeContainer(PhpNamedElement phpNamedElement) {
+ this.phpNamedElement = phpNamedElement;
+ }
+
+ public TwigTypeContainer(String stringElement) {
+ this.stringElement = stringElement;
+ }
+
+ @Nullable
+ public PhpNamedElement getPhpNamedElement() {
+ return phpNamedElement;
+ }
+
+ @Nullable
+ public String getStringElement() {
+ return stringElement;
+ }
+
+ public static Collection<TwigTypeContainer> fromCollection(Collection<? extends PhpNamedElement> phpNamedElements) {
+
+ List<TwigTypeContainer> twigTypeContainerList = new ArrayList<TwigTypeContainer>();
+
+ for(PhpNamedElement phpNamedElement :phpNamedElements) {
+ twigTypeContainerList.add(new TwigTypeContainer(phpNamedElement));
+ }
+
+ return twigTypeContainerList;
+ }
+
+
+}