# A GFStripe osztály és a Stripe-feed meta

> A gf_stripe() hasznos metódusai egyedi kódhoz, és a Stripe-feed meta tulajdonságai.

## A `GFStripe` osztály

A `GFStripe` a bővítmény fő osztálya. A Gravity Forms Add-On keretrendszerének `GFPaymentAddOn` osztályát bővíti. Az alábbi metódusok hasznosak lehetnek egyedi kódnál. A `gf_stripe()` függvény az osztály egy példányát adja vissza.

### `get_payment_feed()`

Visszaadja a bejegyzés feldolgozásához használt feedet. Ha bejegyzés helyett csak az űrlapot adod meg, az első aktív, a feltételes logikának megfelelő feed jön vissza.

```php
$feed = gf_stripe()->get_payment_feed( $entry );
```

| Paraméter | Típus | Jelentés |
|---|---|---|
| `$entry` | Entry Object vagy boolean | A vizsgált bejegyzés. |
| `$form` | Form Object vagy boolean | A feed feltételes logikájának kiértékeléséhez használt űrlap. Alapértéke `false`. |

Visszatérési érték: a feed objektum, vagy `false`.

### `cancel()`

Lemondja annak az ügyfélnek a Stripe-előfizetését, akit a megadott bejegyzésből hoztak létre.

```php
$result = gf_stripe()->cancel( $entry, $feed );
```

| Paraméter | Típus | Jelentés |
|---|---|---|
| `$entry` | Entry Object | A bejegyzés, amelyből az előfizetés vagy az ügyfél létrejött. |
| `$feed` | Feed Object | A feed. Jelenleg nem használja, ezért `false` is átadható. |

Visszatérési érték: `true`, ha a lemondás sikerült, különben `false`.

### `get_amount_export()` és `get_amount_import()`

Az `export` eltávolítja a pénznem jelét, és ha kell, a Stripe által várt legkisebb egységre váltja az összeget (például forintot fillérre vagy dollárt centre). Az `import` ezt fordítja vissza.

```php
$amount = gf_stripe()->get_amount_export( $amount, $currency_code );
$amount = gf_stripe()->get_amount_import( $amount, $currency_code );
```

| Paraméter | Típus | Jelentés |
|---|---|---|
| `$amount` | integer vagy float | Az átalakítandó érték. |
| `$currency_code` | string | A pénznem kódja. |

### `insert_feed()`

Stripe-feedet hoz létre kóddal.

```php
$feed_id = gf_stripe()->insert_feed( $form_id, $is_active, $meta );
```

| Paraméter | Típus | Jelentés |
|---|---|---|
| `$form_id` | integer | Az űrlap azonosítója, amelyhez a feed tartozik. |
| `$is_active` | boolean | Aktív-e a feed. |
| `$meta` | tömb | A feed meta (lásd lent): a tranzakció típusát meghatározó tulajdonságok. |

Visszatérési érték: az új feed azonosítója.

### `add_note()`

Megjegyzést fűz egy bejegyzéshez.

```php
gf_stripe()->add_note( $entry_id, $note, $note_type );
```

| Paraméter | Típus | Jelentés |
|---|---|---|
| `$entry_id` | integer | A bejegyzés azonosítója. |
| `$note` | string | A megjegyzés szövege. |
| `$note_type` | string | A megjegyzés típusa, például `note`, `success` vagy `error`. |

### `log_debug()` és `log_error()`

A bővítmény naplófájljába írnak hibakeresési, illetve hibaüzenetet. Csak bekapcsolt naplózásnál működnek.

```php
gf_stripe()->log_debug( $message );
gf_stripe()->log_error( $message );
```

### `include_stripe_api()`

Betölti a Stripe API-t.

```php
gf_stripe()->include_stripe_api();
```

## A Stripe-feed meta

A feed `meta` tulajdonsága egy asszociatív tömb. Ez határozza meg, milyen tranzakció történjen, és milyen értékek menjenek a Stripe-hoz.

```php
$feed['meta'] = array(
    'feedName'                                => 'Feed neve',
    'transactionType'                         => 'product',
    'paymentAmount'                           => 'form_total',
    'receipt_field'                           => '3',
    'feed_condition_conditional_logic'        => true,
    'feed_condition_conditional_logic_object' => array(
        'conditionalLogic' => array(),
    ),
);
```

A meta értékeit az `rgar()` és `rgars()` függvénnyel érdemes olvasni:

```php
$conditional_logic_enabled = rgars( $feed, 'meta/feedCondition' );

if ( $conditional_logic_enabled ) {
    $logic_rules = rgars( $feed, 'meta/feed_condition_conditional_logic_object/conditionalLogic/rules' );
    foreach ( $logic_rules as $rule ) {
        $field_id = rgar( $rule, 'fieldId' );
        $operator = rgar( $rule, 'operator' );
        $value    = rgar( $rule, 'value' );
        // Itt használhatod a mező azonosítóját, az operátort és az értéket.
    }
}
```

### Általános tulajdonságok

| Tulajdonság | Típus | Jelentés |
|---|---|---|
| `feedName` | string | A feed neve, ahogy a bővítmény feedek lapján látszik. |
| `transactionType` | string | A tranzakció típusa: `product` vagy `subscription`. |
| `metaData` | tömb | Egyedi metaadatok. A Stripe legfeljebb 20 egyedi kulcsot enged. |
| `feed_condition_conditional_logic` | boolean | Be van-e kapcsolva a feed feltételes logikája. Alapértéke `false`. |
| `feed_condition_conditional_logic_object` | tömb | A feltételes logika szabályai. |

A `metaData` egy eleme:

```php
array(
    'key'        => 'gf_custom',
    'value'      => '1.3',
    'custom_key' => 'product_quantity',
);
```

| Kulcs | Jelentés |
|---|---|
| `key` | Értéke `gf_custom`; ezzel jelzed, hogy a `custom_key` mezőt kell használni. |
| `value` | Annak a mezőnek az azonosítója, amelynek az értéke a `custom_key` alatt megy a Stripe-hoz. A Stripe előírása szerint az adatot 500 karakterre vágja. |
| `custom_key` | A Stripe-nak küldött egyedi kulcs, legfeljebb 40 karakter. |

### Termék (egyszeri fizetés) tulajdonságai

Csak akkor érvényesek, ha a `transactionType` értéke `product`.

| Tulajdonság | Jelentés |
|---|---|
| `paymentAmount` | Mi legyen a fizetendő összeg: `form_total` vagy egy termékmező azonosítója. |
| `receipt_field` | Annak a mezőnek az azonosítója, amelyben lévő e-mail-címre a Stripe a nyugtát küldi. |

### Előfizetés tulajdonságai

Csak akkor érvényesek, ha a `transactionType` értéke `subscription`.

| Tulajdonság | Jelentés |
|---|---|
| `recurringAmount` | Az ismétlődő összeg: `form_total` vagy egy termékmező azonosítója. |
| `billingCycle_length` | Milyen gyakran ismétlődjön a fizetés (szám). A legnagyobb érték 1 év, 12 hét vagy 12 hónap. |
| `billingCycle_unit` | Az időszak egysége: `week`, `month` vagy `year`. |
| `setupFee_enabled` | Kell-e beállítási díj. Alapértéke `false`. |
| `setupFee_product` | Annak a termékmezőnek az azonosítója, amely a beállítási díj összegét tartalmazza. |
| `trial_enabled` | Az ismétlődő terhelés azonnal induljon, vagy próbaidőszak után. Alapértéke `false`. |
| `trialPeriod` | A próbaidőszak hossza napban. |
| `customerInformation_email` | Az ügyfél e-mail-címét tartalmazó mező azonosítója. |
| `customerInformation_description` | Az ügyfél leírását tartalmazó mező azonosítója. |
