Generate Field table for shopware 6 docs

generate.sh

#!/bin/bash

# Directory to search
DIRECTORY="src/Core/Framework/DataAbstractionLayer/Field"

# Print the table header
echo "| Name | Description | Extends | Implements StorageAware |"
echo "|:-----------------------------|:-----------------------------------------|:----------------------|:----------------------|"

# Iterate over each file ending with *Field.php in the specified directory
for FILE in "$DIRECTORY"/*Field.php; do
    # Extract the class name
    CLASS_NAME=$(grep -oP 'class \K\w+' "$FILE")

    # Extract the name minus the "Field"
    NAME=${CLASS_NAME%Field}

    # Extract the parent class name
    PARENT_CLASS=$(grep -oP 'extends \K\w+' "$FILE")

    # Check if the class implements StorageAware
    if grep -q 'implements StorageAware' "$FILE"; then
        STORAGE_AWARE="x"
    else
        STORAGE_AWARE=""
    fi

    # Determine the description based on the parent class
    case "$PARENT_CLASS" in
        JsonField)
            DESCRIPTION="Stores a JSON value"
            ;;
        DateTimeField)
            DESCRIPTION="Stores a DateTime value"
            ;;
        FkField)
            DESCRIPTION="Stores a foreign key value"
            ;;
        IntField)
            DESCRIPTION="Stores an integer value"
            ;;
        FloatField)
            DESCRIPTION="Stores a floating-point number"
            ;;
        StringField)
            DESCRIPTION="Stores a string value"
            ;;
        BoolField)
            DESCRIPTION="Stores a boolean value"
            ;;
        BlobField)
            DESCRIPTION="Stores a binary large object (BLOB) value"
            ;;
        *)
            DESCRIPTION="Stores a ${NAME,,} value"
            ;;
    esac

    # Print the class name, description, parent class, and whether it implements StorageAware
    echo "| $CLASS_NAME | $DESCRIPTION | $PARENT_CLASS | $STORAGE_AWARE |"
done