Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Handle all report data received from Google

[3] Fix | Delete

[4] Fix | Delete

class Advanced_Ads_AdSense_Report_Data implements Serializable {

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Cached data life span.

[8] Fix | Delete

[9] Fix | Delete

* @var integer

[10] Fix | Delete

[11] Fix | Delete

const CACHE_DURATION = 3600;

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* DB option name for report by domain.

[15] Fix | Delete

[16] Fix | Delete

* @var string

[17] Fix | Delete

[18] Fix | Delete

const DOMAIN_OPTION = 'advanced_ads_adsense_report_domain';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* DB option name for report by ad unit.

[22] Fix | Delete

[23] Fix | Delete

* @var string

[24] Fix | Delete

[25] Fix | Delete

const UNIT_OPTION = 'advanced_ads_adsense_report_unit';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Daily earnings.

[29] Fix | Delete

[30] Fix | Delete

* @var null|array

[31] Fix | Delete

[32] Fix | Delete

private $earnings;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Report type. 'unit' or 'domain'.

[36] Fix | Delete

[37] Fix | Delete

* @var string

[38] Fix | Delete

[39] Fix | Delete

private $type;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* UNIX timestamp at which the data was obtained from Google.

[43] Fix | Delete

[44] Fix | Delete

* @var int

[45] Fix | Delete

[46] Fix | Delete

private $timestamp = 0;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Currency used in the report.

[50] Fix | Delete

[51] Fix | Delete

* @var string

[52] Fix | Delete

[53] Fix | Delete

private $currency = '';

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Version of Google AdSense Management API used.

[57] Fix | Delete

[58] Fix | Delete

* @var string

[59] Fix | Delete

[60] Fix | Delete

private $version = '';

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* List of domain names found in the report data.

[64] Fix | Delete

[65] Fix | Delete

* @var array

[66] Fix | Delete

[67] Fix | Delete

private $domains = [];

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Instance constructor.

[71] Fix | Delete

[72] Fix | Delete

* @param string $type report type.

[73] Fix | Delete

[74] Fix | Delete

public function __construct( $type = 'unit' ) {

[75] Fix | Delete

$this->type = $type;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Get all domains.

[80] Fix | Delete

[81] Fix | Delete

* @return array the domain list.

[82] Fix | Delete

[83] Fix | Delete

public function get_domains() {

[84] Fix | Delete

return $this->domains;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Get the report timestamp.

[89] Fix | Delete

[90] Fix | Delete

* @return int data timestamp.

[91] Fix | Delete

[92] Fix | Delete

public function get_timestamp() {

[93] Fix | Delete

return $this->timestamp;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Get the currency used in the report.

[98] Fix | Delete

[99] Fix | Delete

* @return string the currency code.

[100] Fix | Delete

[101] Fix | Delete

public function get_currency() {

[102] Fix | Delete

return $this->currency;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Serialize an instance of this class into a string. For PHP version >= 7.4

[107] Fix | Delete

[108] Fix | Delete

* @return array

[109] Fix | Delete

[110] Fix | Delete

public function __serialize() {

[111] Fix | Delete

return [

[112] Fix | Delete

'earnings' => $this->earnings,

[113] Fix | Delete

'type' => $this->type,

[114] Fix | Delete

'timestamp' => $this->timestamp,

[115] Fix | Delete

'currency' => $this->currency,

[116] Fix | Delete

'domains' => $this->domains,

[117] Fix | Delete

];

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Recreate an instance of this class from a string. For PHP version >= 7.4

[122] Fix | Delete

[123] Fix | Delete

* @param array $data the array from __serialize.

[124] Fix | Delete

[125] Fix | Delete

* @return void

[126] Fix | Delete

[127] Fix | Delete

public function __unserialize( $data ) {

[128] Fix | Delete

$this->earnings = $data['earnings'] ?? null;

[129] Fix | Delete

$this->type = $data['type'] ?? null;

[130] Fix | Delete

$this->timestamp = $data['timestamp'] ?? 0;

[131] Fix | Delete

$this->currency = $data['currency'] ?? '';

[132] Fix | Delete

$this->domains = $data['domains'] ?? [];

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Returns serialized object properties. For PHP version < 7.4

[137] Fix | Delete

[138] Fix | Delete

* @return string the serialized data.

[139] Fix | Delete

[140] Fix | Delete

public function serialize() {

[141] Fix | Delete

return serialize(

[142] Fix | Delete

[

[143] Fix | Delete

'earnings' => $this->earnings,

[144] Fix | Delete

'type' => $this->type,

[145] Fix | Delete

'timestamp' => $this->timestamp,

[146] Fix | Delete

'currency' => $this->currency,

[147] Fix | Delete

'domains' => $this->domains,

[148] Fix | Delete

]

[149] Fix | Delete

);

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Set object properties from serialized data string. For PHP version < 7.4

[154] Fix | Delete

[155] Fix | Delete

* @param string $data serilaized data from DB.

[156] Fix | Delete

[157] Fix | Delete

public function unserialize( $data ) {

[158] Fix | Delete

try {

[159] Fix | Delete

$unwrapped = unserialize( $data );

[160] Fix | Delete

} catch ( Exception $ex ) {

[161] Fix | Delete

$unwrapped = [];

[162] Fix | Delete

}

[163] Fix | Delete

$this->__unserialize( $unwrapped );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Update object properties and DB record from a API response.

[168] Fix | Delete

[169] Fix | Delete

* @param array $response API call response from Google.

[170] Fix | Delete

[171] Fix | Delete

public function update_data_from_response( $response ) {

[172] Fix | Delete

$headers = [];

[173] Fix | Delete

$this->version = $response['api_version'];

[174] Fix | Delete

$this->timestamp = $response['timestamp'];

[175] Fix | Delete

foreach ( $response['headers'] as $header ) {

[176] Fix | Delete

if ( $header['type'] === 'METRIC_CURRENCY' ) {

[177] Fix | Delete

$this->currency = $header['currencyCode'];

[178] Fix | Delete

}

[179] Fix | Delete

$headers[] = $header['name'];

[180] Fix | Delete

}

[181] Fix | Delete

$earnings = [];

[182] Fix | Delete

[183] Fix | Delete

if ( ! empty( $response['rows'] ) ) {

[184] Fix | Delete

foreach ( $response['rows'] as $row ) {

[185] Fix | Delete

$earning = new StdClass();

[186] Fix | Delete

foreach ( $row['cells'] as $index => $cell ) {

[187] Fix | Delete

switch ( $headers[ $index ] ) {

[188] Fix | Delete

case 'DATE':

[189] Fix | Delete

$earning->date = new DateTimeImmutable( $cell['value'] );

[190] Fix | Delete

break;

[191] Fix | Delete

case 'ESTIMATED_EARNINGS':

[192] Fix | Delete

$earning->estimated_earning = (float) $cell['value'];

[193] Fix | Delete

break;

[194] Fix | Delete

default: // "DOMAIN_NAME" or "AD_UNIT_ID".

[195] Fix | Delete

$earning->{strtolower( $headers[ $index ] )} = $cell['value'];

[196] Fix | Delete

if ( $headers[ $index ] === 'DOMAIN_NAME' && ! in_array( $cell['value'], $this->domains, true ) ) {

[197] Fix | Delete

$this->domains[] = $cell['value'];

[198] Fix | Delete

}

[199] Fix | Delete

}

[200] Fix | Delete

}

[201] Fix | Delete

$earnings[] = $earning;

[202] Fix | Delete

}

[203] Fix | Delete

}

[204] Fix | Delete

$this->earnings = $earnings;

[205] Fix | Delete

$option_name = $this->type === 'unit' ? self::UNIT_OPTION : self::DOMAIN_OPTION;

[206] Fix | Delete

[207] Fix | Delete

// Delete old options entries.

[208] Fix | Delete

delete_option( 'advanced_ads_adsense_report_DATE_AD_UNIT_CODE_EARNINGS_dashboard' );

[209] Fix | Delete

delete_option( 'advanced_ads_adsense_report_DATE_DOMAIN_NAME_EARNINGS_dashboard' );

[210] Fix | Delete

[211] Fix | Delete

// Save the data instance in DB.

[212] Fix | Delete

update_option( $option_name, $this );

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Returns a data object constructed from saved data. Constructs a new one if there is no usable data.

[217] Fix | Delete

[218] Fix | Delete

* @param string $type report type.

[219] Fix | Delete

[220] Fix | Delete

* @return Advanced_Ads_AdSense_Report_Data

[221] Fix | Delete

[222] Fix | Delete

public static function get_data_from_options( $type ) {

[223] Fix | Delete

$option_name = $type === 'unit' ? self::UNIT_OPTION : self::DOMAIN_OPTION;

[224] Fix | Delete

$option = get_option( $option_name, false );

[225] Fix | Delete

if ( $option === false ) {

[226] Fix | Delete

return new self( $type );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

// PHP version < 7.4.

[230] Fix | Delete

if ( $option instanceof self ) {

[231] Fix | Delete

return $option;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

try {

[235] Fix | Delete

$unserialized = unserialize( $option );

[236] Fix | Delete

if ( $unserialized instanceof self ) {

[237] Fix | Delete

return $unserialized;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

return new self( $type );

[241] Fix | Delete

} catch ( Exception $ex ) {

[242] Fix | Delete

return new self( $type );

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Checks if cached data need to be updated.

[248] Fix | Delete

[249] Fix | Delete

* @return bool true if the stored data has not expired yet.

[250] Fix | Delete

[251] Fix | Delete

public function is_valid() {

[252] Fix | Delete

return $this->timestamp + self::CACHE_DURATION > time();

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Get the earnings sums for display.

[257] Fix | Delete

[258] Fix | Delete

* @param string $filter filter sums by a given domain name or ad unit.

[259] Fix | Delete

[260] Fix | Delete

* @return int[]

[261] Fix | Delete

[262] Fix | Delete

public function get_sums( $filter = '' ) {

[263] Fix | Delete

$today = new DateTimeImmutable();

[264] Fix | Delete

$yesterday = $today->sub( date_interval_create_from_date_string( '1 day' ) );

[265] Fix | Delete

$prev7 = $today->sub( date_interval_create_from_date_string( '7 days' ) );

[266] Fix | Delete

$prev28 = $today->sub( date_interval_create_from_date_string( '28 days' ) );

[267] Fix | Delete

$sums = [

[268] Fix | Delete

'today' => 0,

[269] Fix | Delete

'yesterday' => 0,

[270] Fix | Delete

'7days' => 0,

[271] Fix | Delete

'this_month' => 0,

[272] Fix | Delete

'28days' => 0,

[273] Fix | Delete

];

[274] Fix | Delete

[275] Fix | Delete

// Unit type reports should always have the ad unit id specified.

[276] Fix | Delete

if ( $filter === '' && $this->type === 'unit' ) {

[277] Fix | Delete

return $sums;

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

foreach ( $this->earnings as $value ) {

[281] Fix | Delete

if (

[282] Fix | Delete

( $this->type === 'unit' && false === strpos( $value->ad_unit_id, $filter ) )

[283] Fix | Delete

|| ( ! empty( $filter ) && $this->type === 'domain' && $filter !== $value->domain_name )

[284] Fix | Delete

) {

[285] Fix | Delete

continue;

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

if ( $this->date_ymd( $value->date ) === $this->date_ymd( $today ) ) {

[289] Fix | Delete

$sums['today'] += $value->estimated_earning;

[290] Fix | Delete

}

[291] Fix | Delete

if ( $this->date_ymd( $value->date ) === $this->date_ymd( $yesterday ) ) {

[292] Fix | Delete

$sums['yesterday'] += $value->estimated_earning;

[293] Fix | Delete

}

[294] Fix | Delete

if ( $this->date_ymd( $value->date ) >= $this->date_ymd( $prev7 ) ) {

[295] Fix | Delete

$sums['7days'] += $value->estimated_earning;

[296] Fix | Delete

}

[297] Fix | Delete

if ( $this->date_ymd( $value->date ) >= $this->date_ymd( $prev28 ) ) {

[298] Fix | Delete

$sums['28days'] += $value->estimated_earning;

[299] Fix | Delete

}

[300] Fix | Delete

if ( $value->date->format( 'm' ) === $today->format( 'm' ) ) {

[301] Fix | Delete

$sums['this_month'] += $value->estimated_earning;

[302] Fix | Delete

}

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

return $sums;

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Get an integer representation of a DateTime object to be used in date comparison.

[310] Fix | Delete

[311] Fix | Delete

* @param DateTimeInterface $date the date object.

[312] Fix | Delete

[313] Fix | Delete

* @return int

[314] Fix | Delete

[315] Fix | Delete

private function date_ymd( $date ) {

[316] Fix | Delete

if ( $date instanceof DateTimeInterface ) {

[317] Fix | Delete

return (int) $date->format( 'Ymd' );

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

return 0;

[321] Fix | Delete

}

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete