Tovább a tartalomhoz

Függvények és tulajdonságok

A WC_Subscription fontosabb metódusai (dátumok, fizetési mód, kapcsolódó rendelések) és a WC_Subscriptions_Manager függvényei.

Ez a fejezet az előfizetésekkel dolgozó függvények egy részét mutatja be. Nem oktatóanyag, és nem teljes lista. Feltételezi, hogy ismered az Adatszerkezet és tárolás fejezetet és a WC_Subscription objektumot.

A WC_Subscription metódusai ezekbe a csoportokba sorolhatók: a WC_Abstract_Order és a WC_Order örökölt metódusai (ezeket a WooCommerce kódreferenciája írja le), az ütemezés kezelése, a megújítási fizetési mód kezelése, a kapcsolódó rendelések kezelése és egyéb metódusok.

Az előfizetés számlázási ütemezése: kezdő dátum, próbaidő vége, következő fizetés dátuma, záródátum.

WC_Subscription::get_date( $date_type, $timezone )

Szekció neve “WC_Subscription::get_date( $date_type, $timezone )”

Az ütemezés egy dátumát adja vissza MySQL formátumú szövegként.

  • $date_type (kötelező): start, trial_end, next_payment, last_payment vagy end.
  • $timezone (opcionális): gmt (alap) vagy site.

WC_Subscription::update_dates( $dates, $timezone )

Szekció neve “WC_Subscription::update_dates( $dates, $timezone )”

Beállítja az előfizetés dátumait. A dátumok függnek egymástól, ezért tömböt vár, és figyelned kell, hogy minden dátum érvényes legyen az adott tömb többi eleméhez és az előfizetésben tárolt dátumokhoz képest. Nem ad vissza értéket.

  • $dates (tömb, kötelező): kulcsok start, trial_end, next_payment, last_payment, end; az értékek MySQL formátumú dátum-idő szövegek.
  • $timezone (opcionális): gmt (alap) vagy site.

WC_Subscription::calculate_date( $date_type )

Szekció neve “WC_Subscription::calculate_date( $date_type )”

Az előfizetés számlázási intervalluma és időszaka alapján kiszámít egy dátumot GMT/UTC időzónában, és MySQL formátumú szövegként adja vissza.

  • $date_type (kötelező): trial_end, next_payment, end_of_prepaid_term vagy end.

WC_Subscription::can_date_be_updated( $date_type )

Szekció neve “WC_Subscription::can_date_be_updated( $date_type )”

Megmondja, módosítható-e egy dátum. Logikai értéket ad: true, ha igen.

  • $date_type (kötelező): start, trial_end, next_payment, last_payment vagy end.

Számlázási időszak, próbaidő és hossz

Szekció neve “Számlázási időszak, próbaidő és hossz”

A számlázási időszak a $subscription->get_billing_period(), az intervallum a $subscription->get_billing_interval() hívással kérdezhető le. A próbaidő végének dátuma: $subscription->get_date( 'trial_end' ). A próbaidő időegysége: $subscription->get_trial_period().

Az előfizetésnek nincs trial_length tulajdonsága, mint a terméknek. A hosszat a próbaidő végének dátumából kell kiszámolni a wcs_estimate_periods_between() segédfüggvénnyel:

$subscription_trial_length = wcs_estimate_periods_between( $subscription->get_time( 'start' ), $subscription->get_time( 'trial_end' ), $subscription->get_trial_period() );

Az előfizetés záródátuma: $subscription->get_time( 'end' ). Az előfizetés hossza az időszakok számában:

$subscription_length = wcs_estimate_periods_between( $subscription->get_time( 'start' ), $subscription->get_time( 'end' ), $subscription->get_billing_period() );

Ha a fizetések számát kell tudnod, a kiindulási dátumot a megfelelő dátumra kell alapozni, hogy a fizetések száma helyes legyen, és ne a feliratkozástól a végéig tartó teljes hossz:

if ( WC_Subscriptions_Synchroniser::subscription_contains_synced_product( $subscription->id ) ) {
$length_from_timestamp = $subscription->get_time( 'next_payment' );
} elseif ( $trial_end_timestamp > 0 ) {
$length_from_timestamp = $subscription->get_time( 'trial_end' );
} else {
$length_from_timestamp = $subscription->get_time( 'start' );
}
$subscription_length = wcs_estimate_periods_between( $length_from_timestamp, $subscription->get_time( 'end' ), $subscription->get_billing_period() );

Az előfizetések automatikus vagy kézi megújítást is használhatnak, és a fizetési átjárótól függően különböző funkciókat támogathatnak. Ezért a WC_Subscription több függvényt ad a fizetési mód lekérdezéséhez és módosításához.

Függvény Mit csinál
WC_Subscription::get_total() A WC_Abstract_Order::get_total() örököse: a jövőbeli ismétlődő fizetéskor alapból felszámítandó összeget adja vissza (tizedes szám). A megújítási fizetés tényleges összege a legutóbbi megújítási rendelésből jön, hogy külső kód megújításonként módosíthassa, de az alapérték megegyezik ezzel.
WC_Subscription::is_manual() Logikai érték: kézi megújítást igényel-e az előfizetés (true), vagy automatikus (false).
WC_Subscription::set_requires_manual_renewal( $is_manual ) Beállítja, hogy kézi megújítás kell-e (true) vagy automatikus (false). Nem ad vissza értéket.
WC_Subscription::set_payment_method( $payment_gateway, $payment_meta ) Új fizetési módot és fizetési meta-adatot (például kártyatoken) tárol az előfizetésen a jövőbeli automatikus megújításokhoz. A $payment_gateway egy WC_Payment_Gateway példány, kötelező (az üres alapérték csak a szülőosztály definíciójával való összhang miatt van). A $payment_meta opcionális tömb.
WC_Subscription::payment_method_supports( $feature ) Megmondja, támogat-e egy előfizetési funkciót a fizetési mód (például ismétlődő összeg vagy dátum módosítása). Kézi megújításnál minden funkció támogatott, egyébként csak akkor, ha az előfizetésre beállított átjáró támogatja. A $feature például subscription_suspension, subscription_reactivation, subscription_cancellation, subscription_date_changes vagy subscription_amount_changes. Logikai értéket ad.

Az előfizetés vásárlásához tartozik egy rendelés, a megújításkor és a váltáskor (feljebb vagy lejjebb lépéskor) is jön létre rendelés.

Függvény Mit csinál
WC_Subscription::get_related_orders( $return_fields, $order_type ) Az előfizetéshez kapcsolódó rendelések. $return_fields: all vagy ids (alap). $order_type: parent, renewal, resubscribe, switch vagy any, tömbként több is megadható; alap: array( 'parent', 'renewal' ). Rendelés-azonosítókat vagy WC_Order objektumokat ad vissza tömbben.
WC_Subscription::get_payment_count( $payment_type, $order_types ) A teljesített fizetések száma (megújítási rendelések és esetleg a kezdő rendelés, ha az előfizetés a nyilvános oldalon vásárlással jött létre, és nem kézzel). $payment_type: completed (alap), refunded vagy net. $order_types: parent és/vagy renewal; alap mindkettő. Egész számot ad.
WC_Subscription::get_failed_payment_count() A wc-failed státuszú rendelések alapján a sikertelen fizetések száma.
WC_Subscription::is_one_payment() Logikai érték: az előfizetés csak egy fizetéssel jár-e (például 100 dollár 1 évre, nem évente).
WC_Subscription::get_sign_up_fee() Az előfizetés tételeire a feliratkozáskor felszámított teljes feliratkozási díj (tizedes szám).

Az előfizetések kezelése: WC_Subscriptions_Manager

Szekció neve “Az előfizetések kezelése: WC_Subscriptions_Manager”

A WC_Subscriptions_Manager osztály az előfizetések életciklusát kezeli: státuszt frissít, ha esemény történik (például a rendelés státusza változik), megújítási rendelést készít, ha esedékes a fizetés, és törli az előfizetéseket a felhasználói fiók törlésekor. Az aktiválás és a lemondás függvényei közvetlenül a rendelések státuszváltásaira vannak kötve, így a fizetési átjáróknak elég a WooCommerce API-val a rendelés státuszát módosítaniuk, és az előfizetés státusza magától változik. A nyilvános függvények közvetlenül is hívhatók.

Mindegyik függvény a $order paramétert (WC_Order objektum vagy azonosító) várja, kötelezően, és nem ad vissza értéket, ha mást nem írunk.

Függvény Mit csinál
WC_Subscriptions_Manager::activate_subscriptions_for_order( $order ) Aktiválja a rendeléshez kapcsolódó összes előfizetést.
WC_Subscriptions_Manager::cancel_subscriptions_for_order( $order ) A rendeléshez kapcsolódó összes előfizetést lemondottá teszi. Magától lefut a woocommerce_order_status_cancelled akcióból, amikor a rendelés státusza lemondottra változik.
WC_Subscriptions_Manager::process_subscription_payments_on_order( $order ) A rendeléshez kapcsolódó összes előfizetésen feldolgozza a fizetéseket.
WC_Subscriptions_Manager::process_subscription_payment_failure_on_order( $order ) A rendeléshez kapcsolódó összes előfizetésen feldolgozza a sikertelen fizetéseket.
WC_Subscriptions_Manager::expire_subscriptions_for_order( $order ) A rendelés összes előfizetését lejártnak jelöli.
WC_Subscriptions_Manager::failed_subscription_sign_ups_for_order( $order ) Ha a fizetés vagy a feliratkozás a feldolgozásnál meghiúsul, a rendeléshez kapcsolódó összes előfizetésen feldolgozza a sikertelen fizetést. Magától lefut a woocommerce_order_status_failed akcióból, amikor a rendelés sikertelenre vált.
WC_Subscriptions_Manager::cancel_users_subscriptions( $user_id ) Lemondja a felhasználó összes előfizetését az áruházban. A paraméter: $user_id (egész, kötelező).
WC_Subscriptions_Manager::cancel_users_subscriptions_for_network( $user_id ) Lemondja a felhasználó összes előfizetését a multisite hálózat minden áruházában. A paraméter: $user_id (egész, kötelező).

Készült:

Tiszteletben tartjuk a magánszférádat

Sütiket használunk a böngészési élmény javítására és a forgalom elemzésére. Az analitika csak akkor indul, ha engeded. Adatvédelmi irányelvek, Sütitájékoztató.

Sütibeállítások