Added a validOnly flag to mapLayers to filter for valid layers only

elpaso · elpaso · commit 2bd90da9c1e1 · 2018-11-05T10:24:35.000+01:00
diff --git a/python/core/auto_generated/qgsproject.sip.in b/python/core/auto_generated/qgsproject.sip.in
@@ -733,28 +733,17 @@ Retrieve a list of matching registered layers by layer name.
 .. seealso:: :py:func:`mapLayers`
 %End
 
-    QMap<QString, QgsMapLayer *> mapLayers() const;
+    QMap<QString, QgsMapLayer *> mapLayers( const bool validOnly = false ) const;
 %Docstring
 Returns a map of all registered layers by layer ID.
 
-.. seealso:: :py:func:`mapLayer`
-
-.. seealso:: :py:func:`mapLayersByName`
-
-.. seealso:: :py:func:`layers`
-%End
-
-    QMap<QString, QgsMapLayer *> validMapLayers() const;
-%Docstring
-Returns a map of all registered valid layers by layer ID.
+:param validOnly: if set only valid layers will be returned
 
 .. seealso:: :py:func:`mapLayer`
 
 .. seealso:: :py:func:`mapLayersByName`
 
 .. seealso:: :py:func:`layers`
-
-.. versionadded:: 3.6
 %End
 
     bool isZipped() const;
@@ -781,7 +770,7 @@ The legendLayersAdded() signal is emitted only if addToLegend is true.
                       the layers yourself. Not available in Python.
 
 :return: a list of the map layers that were added
-         successfully. If a layer is invalid, or already exists in the registry,
+         successfully. If a layer or already exists in the registry,
          it will not be part of the returned QList.
 
 
diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp
@@ -2745,14 +2745,9 @@ void QgsProject::reloadAllLayers()
   }
 }
 
-QMap<QString, QgsMapLayer *> QgsProject::mapLayers() const
+QMap<QString, QgsMapLayer *> QgsProject::mapLayers( const bool validOnly ) const
 {
-  return mLayerStore->mapLayers();
-}
-
-QMap<QString, QgsMapLayer *> QgsProject::validMapLayers() const
-{
-  return mLayerStore->validMapLayers();
+  return validOnly ? mLayerStore->validMapLayers() : mLayerStore->mapLayers();
 }
 
 QgsTransactionGroup *QgsProject::transactionGroup( const QString &providerKey, const QString &connString )
diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h
@@ -713,20 +713,13 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
 
     /**
      * Returns a map of all registered layers by layer ID.
+     *
+     * \param validOnly if set only valid layers will be returned
      * \see mapLayer()
      * \see mapLayersByName()
      * \see layers()
      */
-    QMap<QString, QgsMapLayer *> mapLayers() const;
-
-    /**
-     * Returns a map of all registered valid layers by layer ID.
-     * \see mapLayer()
-     * \see mapLayersByName()
-     * \see layers()
-     * \since QGIS 3.6
-     */
-    QMap<QString, QgsMapLayer *> validMapLayers() const;
+    QMap<QString, QgsMapLayer *> mapLayers( const bool validOnly = false ) const;
 
     /**
      * Returns true if the project comes from a zip archive, false otherwise.
@@ -769,7 +762,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
      *                      the layers yourself. Not available in Python.
      *
      * \returns a list of the map layers that were added
-     *         successfully. If a layer is invalid, or already exists in the registry,
+     *         successfully. If a layer or already exists in the registry,
      *         it will not be part of the returned QList.
      *
      * \note As a side-effect QgsProject is made dirty.
diff --git a/tests/src/python/test_qgsproject.py b/tests/src/python/test_qgsproject.py
@@ -254,12 +254,12 @@ def test_addMapLayerInvalid(self):
 
         vl = QgsVectorLayer("Point?field=x:string", 'test', "xxx")
         self.assertEqual(QgsProject.instance().addMapLayer(vl), vl)
-        self.assertFalse(vl in QgsProject.instance().validMapLayers().values())
+        self.assertFalse(vl in QgsProject.instance().mapLayers(True).values())
         self.assertEqual(len(QgsProject.instance().mapLayersByName('test')), 1)
         self.assertEqual(QgsProject.instance().count(), 1)
         self.assertEqual(QgsProject.instance().validCount(), 0)
 
-        self.assertEqual(len(QgsProject.instance().validMapLayers()), 0)
+        self.assertEqual(len(QgsProject.instance().mapLayers(True)), 0)
 
         QgsProject.instance().removeAllMapLayers()
 
@@ -323,7 +323,7 @@ def test_addMapLayersInvalid(self):
 
         vl = QgsVectorLayer("Point?field=x:string", 'test', "xxx")
         self.assertEqual(QgsProject.instance().addMapLayers([vl]), [vl])
-        self.assertFalse(vl in QgsProject.instance().validMapLayers().values())
+        self.assertFalse(vl in QgsProject.instance().mapLayers(True).values())
         self.assertEqual(len(QgsProject.instance().mapLayersByName('test')), 1)
         self.assertEqual(QgsProject.instance().count(), 1)
         self.assertEqual(QgsProject.instance().validCount(), 0)

Original file line number	Diff line number	Diff line change
`@@ -2745,14 +2745,9 @@ void QgsProject::reloadAllLayers()`
`2745`	`2745`	`}`
`2746`	`2746`	`}`
`2747`	`2747`
`2748`		`-QMap<QString, QgsMapLayer *> QgsProject::mapLayers() const`
	`2748`	`+QMap<QString, QgsMapLayer *> QgsProject::mapLayers( const bool validOnly ) const`
`2749`	`2749`	`{`
`2750`		`- return mLayerStore->mapLayers();`
`2751`		`-}`
`2752`		`-`
`2753`		`-QMap<QString, QgsMapLayer *> QgsProject::validMapLayers() const`
`2754`		`-{`
`2755`		`- return mLayerStore->validMapLayers();`
	`2750`	`+ return validOnly ? mLayerStore->validMapLayers() : mLayerStore->mapLayers();`
`2756`	`2751`	`}`
`2757`	`2752`
`2758`	`2753`	`QgsTransactionGroup *QgsProject::transactionGroup( const QString &providerKey, const QString &connString )`