Move layer resolver into a static method

qgis · Jun 10, 2019 · f9b50b5 · f9b50b5
1 parent dcc779a
commit f9b50b5
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 47 deletions.
diff --git a/python/core/auto_generated/fieldformatter/qgsvaluerelationfieldformatter.sip.in b/python/core/auto_generated/fieldformatter/qgsvaluerelationfieldformatter.sip.in
@@ -121,6 +121,15 @@ Check whether the ``feature`` has all values required by the ``expression``
 .. versionadded:: 3.2
 %End
 
+    static QString resolveLayer( const QVariantMap &config );
+%Docstring
+Returns the (possibly empty) layer ID from the widget ``config``
+
+.. versionadded:: 3.8
+%End
+
+
+
 };
 
 

diff --git a/python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in
@@ -78,7 +78,7 @@ Access the widget managed by this wrapper
 %End
 
 
-    virtual void setConfig( const QVariantMap &config );
+    void setConfig( const QVariantMap &config );
 %Docstring
 Will set the config of this wrapper to the specified config.
 

diff --git a/src/core/fieldformatter/qgsvaluerelationfieldformatter.cpp b/src/core/fieldformatter/qgsvaluerelationfieldformatter.cpp
@@ -118,7 +118,7 @@ QgsValueRelationFieldFormatter::ValueRelationCache QgsValueRelationFieldFormatte
 {
   ValueRelationCache cache;
 
-  QgsVectorLayer *layer = QgsProject::instance()->mapLayer<QgsVectorLayer *>( config.value( QStringLiteral( "Layer" ) ).toString() );
+  QgsVectorLayer *layer = QgsProject::instance()->mapLayer<QgsVectorLayer *>( resolveLayer( config ) );
 
   if ( !layer )
     return cache;
@@ -273,3 +273,26 @@ bool QgsValueRelationFieldFormatter::expressionIsUsable( const QString &expressi
     return false;
   return true;
 }
+
+QString QgsValueRelationFieldFormatter::resolveLayer( const QVariantMap &config )
+{
+  if ( QgsProject::instance()->mapLayer<QgsVectorLayer *>( config.value( QStringLiteral( "Layer" ) ).toString() ) )
+  {
+    return config.value( QStringLiteral( "Layer" ) ).toString();
+  }
+  const auto name { config.value( QStringLiteral( "LayerName" ) ).toString() };
+  if ( ! name.isEmpty() )
+  {
+    const auto constLayers { QgsProject::instance()->mapLayers( true ) };
+    for ( const QgsMapLayer *l : constLayers )
+    {
+      const QgsVectorLayer *vl { qobject_cast<const QgsVectorLayer *>( l ) };
+      if ( vl && vl->name() == name )
+      {
+        return vl->id();
+      }
+    }
+  }
+  return QString();
+}
+
diff --git a/src/core/fieldformatter/qgsvaluerelationfieldformatter.h b/src/core/fieldformatter/qgsvaluerelationfieldformatter.h
@@ -119,6 +119,14 @@ class CORE_EXPORT QgsValueRelationFieldFormatter : public QgsFieldFormatter
      */
     static bool expressionIsUsable( const QString &expression, const QgsFeature &feature );
 
+    /**
+     * Returns the (possibly empty) layer ID from the widget \a config
+     * \since QGIS 3.8
+     */
+    static QString resolveLayer( const QVariantMap &config );
+
+
+
 };
 
 Q_DECLARE_METATYPE( QgsValueRelationFieldFormatter::ValueRelationCache )

diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h
@@ -117,7 +117,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject
      *
      * \param config The config for this wrapper
      */
-    virtual void setConfig( const QVariantMap &config );
+    void setConfig( const QVariantMap &config );
 
     /**
      * Set the context in which this widget is shown

diff --git a/src/gui/editorwidgets/qgsvaluerelationconfigdlg.cpp b/src/gui/editorwidgets/qgsvaluerelationconfigdlg.cpp
@@ -18,6 +18,7 @@
 #include "qgsvectorlayer.h"
 #include "qgsexpressionbuilderdialog.h"
 #include "qgsexpressioncontextutils.h"
+#include "qgsvaluerelationfieldformatter.h"
 
 QgsValueRelationConfigDlg::QgsValueRelationConfigDlg( QgsVectorLayer *vl, int fieldIdx, QWidget *parent )
   : QgsEditorConfigWidget( vl, fieldIdx, parent )
@@ -70,24 +71,7 @@ QVariantMap QgsValueRelationConfigDlg::config()
 
 void QgsValueRelationConfigDlg::setConfig( const QVariantMap &config )
 {
-  QgsVectorLayer *lyr = QgsProject::instance()->mapLayer<QgsVectorLayer *>( config.value( QStringLiteral( "Layer" ) ).toString() );
-  // If layer is null, let's try to match it against name and provider
-  if ( ! lyr )
-  {
-    const auto name { config.value( QStringLiteral( "LayerName" ) ).toString() };
-    if ( ! name.isEmpty() )
-    {
-      for ( const auto &l : QgsProject::instance()->mapLayers( true ) )
-      {
-        QgsVectorLayer *vl { qobject_cast<QgsVectorLayer *>( l ) };
-        if ( vl && vl->name() == name )
-        {
-          lyr = vl;
-          break;
-        }
-      }
-    }
-  }
+  QgsVectorLayer *lyr = QgsProject::instance()->mapLayer<QgsVectorLayer *>( QgsValueRelationFieldFormatter::resolveLayer( config ) );
   mLayerName->setLayer( lyr );
   mKeyColumn->setField( config.value( QStringLiteral( "Key" ) ).toString() );
   mValueColumn->setField( config.value( QStringLiteral( "Value" ) ).toString() );

diff --git a/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.cpp b/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.cpp
@@ -302,7 +302,7 @@ int QgsValueRelationWidgetWrapper::columnCount() const
 
 QVariant::Type QgsValueRelationWidgetWrapper::fkType() const
 {
-  QgsVectorLayer *layer = QgsProject::instance()->mapLayer<QgsVectorLayer *>( config().value( QStringLiteral( "Layer" ) ).toString() );
+  QgsVectorLayer *layer = QgsProject::instance()->mapLayer<QgsVectorLayer *>( QgsValueRelationFieldFormatter::resolveLayer( config() ) );
   if ( layer )
   {
     QgsFields fields = layer->fields();
@@ -435,25 +435,3 @@ void QgsValueRelationWidgetWrapper::setEnabled( bool enabled )
   else
     QgsEditorWidgetWrapper::setEnabled( enabled );
 }
-
-void QgsValueRelationWidgetWrapper::setConfig( const QVariantMap &config )
-{
-  QVariantMap cfg { config };
-  if ( ! QgsProject::instance()->mapLayer<QgsVectorLayer *>( config.value( QStringLiteral( "Layer" ) ).toString() ) )
-  {
-    const auto name { config.value( QStringLiteral( "LayerName" ) ).toString() };
-    if ( ! name.isEmpty() )
-    {
-      for ( const auto &l : QgsProject::instance()->mapLayers( true ) )
-      {
-        QgsVectorLayer *vl { qobject_cast<QgsVectorLayer *>( l ) };
-        if ( vl && vl->name() == name )
-        {
-          cfg[ QStringLiteral( "Layer" ) ] = vl->id();
-          break;
-        }
-      }
-    }
-  }
-  QgsWidgetWrapper::setConfig( cfg );
-}
diff --git a/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h b/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h
@@ -73,9 +73,6 @@ class GUI_EXPORT QgsValueRelationWidgetWrapper : public QgsEditorWidgetWrapper
 
     void setEnabled( bool enabled ) override;
 
-    void setConfig( const QVariantMap &config ) override;
-
-
   protected:
     QWidget *createWidget( QWidget *parent ) override;
     void initWidget( QWidget *editor ) override;