category_with_firebase 1.0.3+1

category_with_firebase

category_with_firebase

This library is made for individual projects to manage categories using Firebase Firestore.

Getting Started

Category Structure

The InitCategory class represents the structure of a category.

class InitCategory {
    InitCategory({
        required this.name,
        required this.depth,
        this.id,
        this.parentId,
        this.ordinary,
    });
    final String name;
    final int depth;
    final String? id;
    final String? parentId;
    final int? ordinary;

    Map<String, dynamic> makeMap() {
    return {
        'name': name,
        'depth': depth,
        'id': id ?? '',
        'parentId': parentId ?? '',
        'ordinary': ordinary ?? 0,
    };
}

static InitCategory loadMap(Map<String, dynamic> map, String id) {
    return InitCategory(
        name: map['name'],
        depth: map['depth'],
        id: id,
        parentId: map['parentId'],
        ordinary: map['ordinary'],
        );
    }
}

InitCategory Fields

• name: Category Name
• id: Unique ID from Firebase database
• parentId: Parent ID from Firebase database
• ordinary: Order of the category, unique
• depth: Depth of the category. 1 is the top level category. You can increase the depth for more subcategories. Example: 1 = Main Category, 2 = Secondary Category, 3 = Tertiary Category

CategoryCRUD

The CategoryCRUD class provides functions for Firebase database logic.

Methods

addOrdinary

Adds an ordinary value to a category.

static Future<void> addOrdinary({required String collection, required String id}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • id (String): The document ID of the category.

• Description:

  • Retrieves all documents in the specified collection.
  • Finds the maximum ordinary value.
  • Sets the ordinary value of the specified document to max + 1.

addCategory

Adds a new category to the specified collection.

static Future<void> addCategory({
    required String collection,
    required InitCategory category,
    String? sub
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • category (InitCategory): The category object to be added.
  • sub (String, optional): The parent ID of the category.

• Description:

  • Adds a new document to the specified collection.
  • Updates the document with its own ID and the parent ID.
  • Sets the ordinary value.

getCategories

Retrieves all categories from the specified collection.

static Future<List<InitCategory>> getCategories({
    required String collection
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.

• Returns:

  • Future<List<InitCategory>>: A list of categories.

• Description:

  • Retrieves all documents in the specified collection.
  • Maps the documents to InitCategory objects.
  • Sorts the categories by their ordinary value.

getMain

Retrieves main categories from the specified collection.

static Future<List<InitCategory>> getMain({
    required String collection
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.

• Returns:

  • Future<List<InitCategory>>: A list of main categories.

• Description:

  • Retrieves all documents in the specified collection where the depth is 1.
  • Maps the documents to InitCategory objects.
  • Sorts the categories by their ordinary value.

getSecondary

Retrieves secondary categories from the specified collection.

static Future<List<InitCategory>> getSecondary({
    required String collection,
    required String parentId
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • parentId (String): The ID of the parent category.

• Returns:

  • Future<List<InitCategory>>: A list of secondary categories.

• Description:

  • Retrieves all documents in the specified collection where the depth is 2 and the parent ID matches.
  • Maps the documents to InitCategory objects.
  • Sorts the categories by their ordinary value.

getTertiary

Retrieves tertiary categories from the specified collection.

static Future<List<InitCategory>> getTertiary({
    required String collection,
    required String parentId
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • parentId (String): The ID of the parent category.

• Returns:

  • Future<List<InitCategory>>: A list of tertiary categories.

• Description:

  • Retrieves all documents in the specified collection where the depth is 3 and the parent ID matches.
  • Maps the documents to InitCategory objects.
  • Sorts the categories by their ordinary value.

updateCategory

Updates the name of a category.

static Future<void> updateCategory({
    required String collection,
    required String id,
    required String name
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • id (String): The document ID of the category.
  • name (String): The new name of the category.

• Description:

  • Updates the specified document with the new name.

deleteCategory

Deletes a category from the specified collection.

static Future<void> deleteCategory({
    required String collection,
    required String id
}) async

• Parameters:

  • collection (String): The name of the Firestore collection.
  • id (String): The document ID of the category.

• Description:

  • Deletes the specified document from the collection.

Provided by Luna Shechren https://github.com/shechren https://shechren.github.io/lunetzsche/