# mageworx/module-donations-graphql

`composer require mageworx/module-donations-graphql`

Canonical URL: https://packagento.com/mageworx/module-donations-graphql

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 1.1.1 — released 2026-02-12
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageworx/module-donations-graphql and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageworx/module-donations-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## README

GraphQL API module for Mageworx [Magento 2 Donations Suite](https://www.mageworx.com/magento-2-donations-suite.html) extension. 

### Installation
**1) Copy-to-paste method**
- Download this module and upload it to the `app/code/MageWorx/DonationsGraphQl` directory *(create "DonationsGraphQl" first if missing)*

**2) Installation using composer (from packagist)**
- Execute the following command: `composer require mageworx/module-donation-graph-ql`

### How to use
**1.** mwDonationsInfo query returns the information about donations

**Syntax**<br />
```
mwDonationsInfo: MwDonationsInfo
```

The MwDonationsInfo object may contain the following attributes:

```
min_value: Float @doc(description: "Minimum donation amount")
default_description: String @doc(description: "Donation default description")
amount_placeholder: String @doc(description: "Donation amount placeholder")
default_charity_id: Int @doc(description: "Default organization")
predefined_values: [Float] @doc(description: "Predefined donation amounts")
allow_round_up: Boolean @doc(description: "Allow Round Up Donation")
enable_round_up_by_default: Boolean @doc(description: "Enable Round Up by default")
is_gift_aid_allowed: Boolean @doc(description: "Indicates if gift aid donations are allowed")
gift_aid_message: String @doc(description: "Gift Aid confirmation message")
charities: [MwCharity] @doc(description: "An array of Charities")
```

The MwCharity object may contain the following attributes:

```
id: Int @doc(description: "Charity ID")
name: String @doc(description: "Charity name")
description: String @doc(description: "Charity description")
sort_order: Int @doc(description: "Sort Order")
```

**Request:**

```
{
    mwDonationsInfo {
        min_value
        default_description
        amount_placeholder
        default_charity_id
        predefined_values
        allow_round_up
        enable_round_up_by_default
        is_gift_aid_allowed
        gift_aid_message
        charities {
            id
            name
            description
            sort_order
        }
    }
}
```

**Response:**

```json
{
    "data": {
        "mwDonationsInfo": {
            "min_value": 10,
            "default_description": "Default Description: Default text of the donation box, shown on the front-end",
            "amount_placeholder": "Enter your donation",
            "default_charity_id": 3,
            "predefined_values": [
                15,
                20,
                25
            ],
            "allow_round_up": true,
            "enable_round_up_by_default": true,
            "is_gift_aid_allowed": true,
            "gift_aid_message": "I confirm I'm a UK taxpayer.",
            "charities": [
                {
                    "id": 2,
                    "name": "Don Org 1 - def_st_v - name",
                    "description": "Don Org 1 - def_st_v - descr",
                    "sort_order": 0
                },
                {
                    "id": 3,
                    "name": "test 2",
                    "description": "Description for test 2",
                    "sort_order": 0
                }
            ]
        }
    }
}
```

**2.** The *addMwDonationToCart* mutation is used to add a donation to the shopping cart.

**Syntax**<br />
```
addMwDonationToCart(input: AddMwDonationToCartInput): AddMwDonationToCartOutput
```

The AddMwDonationToCartInput object may contain the following attributes:

```
cart_id: String! @doc(description:"The unique ID that identifies the customer's cart")
charity_id: Int @doc(description: "Charity ID")
amount: Float @doc(description: "Donation amount")
round_up: Boolean @doc(description: "Round up")
uk_confirm: Boolean @doc(description: "Confirms UK Taxpayer")
gift_aid_address: String @doc(description: "UK address")
```

The AddMwDonationToCartOutput object contains the Cart object. We add the new attribute *added_mw_donation* to the Cart object.
```
added_mw_donation: AddedMwDonation @doc(description:"Added donation")
```

The AddedMwDonation object may contain the following attributes:

```
charity_id: Int @doc(description: "Charity ID")
charity_name: String @doc(description: "Charity name")
global_amount: Float @doc(description: "Global donation amount")
amount: Float @doc(description: "Donation amount")
round_up: Boolean @doc(description: "Round up")
gift_aid_address: String @doc(description: "UK address")
```

**Request:**

```
mutation {
  addMwDonationToCart(
    input: {
      cart_id: "kPi7RAFpz6qNJMEYDmjwXenMWvj5NqSz"
      charity_id: 2
      amount: 20
      round_up: false
      uk_confirm: true
      gift_aid_address: "test address. API"
    }
  ) {
    cart {
      items {
        id
        product {
          sku
          stock_status
        }
        quantity
      }
      added_mw_donation {
            charity_id
            charity_name
            global_amount
            amount
            round_up
            gift_aid_address
        }
    }
  }
}
```

**Response:**

_(README truncated for .md surface. Full README on https://packagento.com/mageworx/module-donations-graphql.)_

## Recent Versions

| Version | Released |
|---|---|
| 1.1.1 | 2026-02-12 |
| 1.1.0 | 2021-11-05 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=102.0.0 <104 |
| magento/module-catalog | >= 102.0.0 < 105 |
| magento/module-quote-graph-ql | >= 100.3.2 < 100.5 |
| mageworx/module-donations | >= 1.5.5 |

## Quality

Latest release (1.1.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | not tested | – | – |
| 2.4.8 | – | not tested | not tested | – |
| 2.4.9 | – | – | not tested | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Warning | 11 | 11 rule violations (UnusedFormalParameter:10, NPathComplexity:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | Error |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | N/A | 0 | no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1 |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageworx/module-donations-graphql"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageworx is a Magento 2 vendor on Packagento. See https://packagento.com/mageworx.md for their full catalogue.