Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\XML_Sitemaps

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Sitemap Cache Data object, manages sitemap data stored in cache.

[8] Fix | Delete

[9] Fix | Delete

class WPSEO_Sitemap_Cache_Data implements Serializable, WPSEO_Sitemap_Cache_Data_Interface {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Sitemap XML data.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

private $sitemap = '';

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Status of the sitemap, usable or not.

[20] Fix | Delete

[21] Fix | Delete

* @var string

[22] Fix | Delete

[23] Fix | Delete

private $status = self::UNKNOWN;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Set the sitemap XML data

[27] Fix | Delete

[28] Fix | Delete

* @param string $sitemap XML Content of the sitemap.

[29] Fix | Delete

[30] Fix | Delete

* @return void

[31] Fix | Delete

[32] Fix | Delete

public function set_sitemap( $sitemap ) {

[33] Fix | Delete

[34] Fix | Delete

if ( ! is_string( $sitemap ) ) {

[35] Fix | Delete

$sitemap = '';

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

$this->sitemap = $sitemap;

[39] Fix | Delete

[40] Fix | Delete

[41] Fix | Delete

* Empty sitemap is not usable.

[42] Fix | Delete

[43] Fix | Delete

if ( ! empty( $sitemap ) ) {

[44] Fix | Delete

$this->set_status( self::OK );

[45] Fix | Delete

}

[46] Fix | Delete

else {

[47] Fix | Delete

$this->set_status( self::ERROR );

[48] Fix | Delete

}

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Set the status of the sitemap, is it usable.

[53] Fix | Delete

[54] Fix | Delete

* @param bool|string $usable Is the sitemap usable or not.

[55] Fix | Delete

[56] Fix | Delete

* @return void

[57] Fix | Delete

[58] Fix | Delete

public function set_status( $usable ) {

[59] Fix | Delete

[60] Fix | Delete

if ( $usable === self::OK ) {

[61] Fix | Delete

$this->status = self::OK;

[62] Fix | Delete

[63] Fix | Delete

return;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

if ( $usable === self::ERROR ) {

[67] Fix | Delete

$this->status = self::ERROR;

[68] Fix | Delete

$this->sitemap = '';

[69] Fix | Delete

[70] Fix | Delete

return;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

$this->status = self::UNKNOWN;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Is the sitemap usable.

[78] Fix | Delete

[79] Fix | Delete

* @return bool True if usable, False if bad or unknown.

[80] Fix | Delete

[81] Fix | Delete

public function is_usable() {

[82] Fix | Delete

[83] Fix | Delete

return $this->status === self::OK;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Get the XML content of the sitemap.

[88] Fix | Delete

[89] Fix | Delete

* @return string The content of the sitemap.

[90] Fix | Delete

[91] Fix | Delete

public function get_sitemap() {

[92] Fix | Delete

[93] Fix | Delete

return $this->sitemap;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Get the status of the sitemap.

[98] Fix | Delete

[99] Fix | Delete

* @return string Status of the sitemap, 'ok'/'error'/'unknown'.

[100] Fix | Delete

[101] Fix | Delete

public function get_status() {

[102] Fix | Delete

[103] Fix | Delete

return $this->status;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* String representation of object.

[108] Fix | Delete

[109] Fix | Delete

* {@internal This magic method is only "magic" as of PHP 7.4 in which the magic method was introduced.}

[110] Fix | Delete

[111] Fix | Delete

* @link https://www.php.net/language.oop5.magic#object.serialize

[112] Fix | Delete

* @link https://wiki.php.net/rfc/custom_object_serialization

[113] Fix | Delete

[114] Fix | Delete

* @since 17.8.0

[115] Fix | Delete

[116] Fix | Delete

* @return array The data to be serialized.

[117] Fix | Delete

[118] Fix | Delete

public function __serialize() { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__serializeFound

[119] Fix | Delete

[120] Fix | Delete

$data = [

[121] Fix | Delete

'status' => $this->status,

[122] Fix | Delete

'xml' => $this->sitemap,

[123] Fix | Delete

];

[124] Fix | Delete

[125] Fix | Delete

return $data;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Constructs the object.

[130] Fix | Delete

[131] Fix | Delete

* {@internal This magic method is only "magic" as of PHP 7.4 in which the magic method was introduced.}

[132] Fix | Delete

[133] Fix | Delete

* @link https://www.php.net/language.oop5.magic#object.serialize

[134] Fix | Delete

* @link https://wiki.php.net/rfc/custom_object_serialization

[135] Fix | Delete

[136] Fix | Delete

* @since 17.8.0

[137] Fix | Delete

[138] Fix | Delete

* @param array $data The unserialized data to use to (re)construct the object.

[139] Fix | Delete

[140] Fix | Delete

* @return void

[141] Fix | Delete

[142] Fix | Delete

public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound

[143] Fix | Delete

[144] Fix | Delete

$this->set_sitemap( $data['xml'] );

[145] Fix | Delete

$this->set_status( $data['status'] );

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* String representation of object.

[150] Fix | Delete

[151] Fix | Delete

* {@internal The magic methods take precedence over the Serializable interface.

[152] Fix | Delete

* This means that in practice, this method will now only be called on PHP < 7.4.

[153] Fix | Delete

* For PHP 7.4 and higher, the magic methods will be used instead.}

[154] Fix | Delete

[155] Fix | Delete

* {@internal The Serializable interface is being phased out, in favour of the magic methods.

[156] Fix | Delete

* This method should be deprecated and removed and the class should no longer

[157] Fix | Delete

* implement the `Serializable` interface.

[158] Fix | Delete

* This change, however, can't be made until the minimum PHP version goes up to PHP 7.4 or higher.}

[159] Fix | Delete

[160] Fix | Delete

* @link http://php.net/manual/en/serializable.serialize.php

[161] Fix | Delete

* @link https://wiki.php.net/rfc/phase_out_serializable

[162] Fix | Delete

[163] Fix | Delete

* @since 5.1.0

[164] Fix | Delete

[165] Fix | Delete

* @return string The string representation of the object or null in C-format.

[166] Fix | Delete

[167] Fix | Delete

public function serialize() {

[168] Fix | Delete

[169] Fix | Delete

return serialize( $this->__serialize() );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

/**

[173] Fix | Delete

* Constructs the object.

[174] Fix | Delete

[175] Fix | Delete

* {@internal The magic methods take precedence over the Serializable interface.

[176] Fix | Delete

* This means that in practice, this method will now only be called on PHP < 7.4.

[177] Fix | Delete

* For PHP 7.4 and higher, the magic methods will be used instead.}

[178] Fix | Delete

[179] Fix | Delete

* {@internal The Serializable interface is being phased out, in favour of the magic methods.

[180] Fix | Delete

* This method should be deprecated and removed and the class should no longer

[181] Fix | Delete

* implement the `Serializable` interface.

[182] Fix | Delete

* This change, however, can't be made until the minimum PHP version goes up to PHP 7.4 or higher.}

[183] Fix | Delete

[184] Fix | Delete

* @link http://php.net/manual/en/serializable.unserialize.php

[185] Fix | Delete

* @link https://wiki.php.net/rfc/phase_out_serializable

[186] Fix | Delete

[187] Fix | Delete

* @since 5.1.0

[188] Fix | Delete

[189] Fix | Delete

* @param string $data The string representation of the object in C or O-format.

[190] Fix | Delete

[191] Fix | Delete

* @return void

[192] Fix | Delete

[193] Fix | Delete

public function unserialize( $data ) {

[194] Fix | Delete

[195] Fix | Delete

$data = unserialize( $data );

[196] Fix | Delete

$this->__unserialize( $data );

[197] Fix | Delete

}

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete