La
classe EDD_Payment_Stats est conçue pour fournir un moyen simple de récupérer les statistiques de revenus et de ventes pour l'ensemble du magasin, ou des produits spécifiques, pour des périodes désignées, telles que cette semaine, le mois dernier, aujourd'hui, l'année dernière, etc.
Pour utiliser
EDD_Payment_Stats, vous devez instancier une nouvelle instance de la classe :
$stats = new EDD_Payment_Stats;
Une fois la classe instanciée, vous pouvez utiliser n'importe laquelle des fonctions membres suivantes :
// Retrieve earnings $stats->get_earnings( $download_id = 0, $start_date = false, $end_date = false ); // Retrieve sales $stats->get_sales( $download_id = 0, $start_date = false, $end_date = false ); // Retrieve a list of the best selling Download products $stats->get_best_selling( $number = 10 );
Pour get_sales() et get_earnings(), les paramètres suivants peuvent être passés :
$download_id – Le numéro d'identification du produit pour lequel récupérer les statistiques. Si 0 ou toute autre valeur vide est passée, les statistiques seront récupérées pour l'ensemble du magasin.
$start_date – La date de début pour récupérer les statistiques. Si vous souhaitez récupérer les statistiques pour l'une des périodes prédéfinies, passez simplement la période, telle que « aujourd'hui » ou « hier ». Ce paramètre peut être une chaîne de date, un horodatage ou une date formatée dans n'importe quel format standard.
$end_date – La date de fin pour récupérer les statistiques. Si vous souhaitez récupérer les statistiques pour l'une des périodes prédéfinies, laissez ce champ vide. Ce paramètre peut être une chaîne de date, un horodatage ou une date formatée dans n'importe quel format standard.
Les statistiques peuvent être récupérées pour toute période de temps prédéfinie. Ces options incluent :
- aujourd'hui
- hier
- cette_semaine
- semaine_derniere
- ce_mois
- mois_dernier
- ce_trimestre
- trimestre_dernier
- cette_annee
- annee_derniere
Exemples
// Store-wide sales for this month: echo $stats->get_sales( 0, 'this_month' ); Returns an integer, the sum of sales in the given time span
// Store-wide earnings for August 2, 2013 echo $stats->get_earnings( 0, 'August 2, 2013' ); Returns an integer if earnings are a whole number, a float rounded to 2 if a fractional number, like 42.73
// Sales for download ID 44 from July 2 to August 5, 2013 echo $stats->get_sales( 44, 'July 2, 2013', 'August 5, 2013' );
// Earnings for download ID 52 for December 5, 2012 echo $stats->get_earnings( 52, '12-05-2012' )
$best_selling = $stats->get_best_selling( '10' );
Returns an array of the 10 best selling products, like this:
Array
(
[0] => stdClass Object
(
[download_id] => 68
[sales] => 3
)
[1] => stdClass Object
(
[download_id] => 120
[sales] => 2
)
)
