sitemap-buffer-video.php — Jetpack – WP Security, Backup, Speed, & Growth 16.0-beta

jetpack / modules / sitemaps / sitemap-buffer-video.php

jetpack / modules / sitemaps Last commit date

sitemap-buffer-video.php

86 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	// phpcs:disable Generic.Classes.DuplicateClassName.Found -- sitemap-builder.php will require correct class file.
3	/**
4	* Sitemaps (per the protocol) are essentially lists of XML fragments;
5	* lists which are subject to size constraints. The Jetpack_Sitemap_Buffer_Video
6	* extends the Jetpack_Sitemap_Buffer class to represent the single video sitemap
7	* buffer.
8	*
9	* @since 5.3.0
10	* @package automattic/jetpack
11	*/
12
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit( 0 );
15	}
16
17	/**
18	* A buffer for constructing sitemap video xml files.
19	*
20	* @since 5.3.0
21	*/
22	class Jetpack_Sitemap_Buffer_Video extends Jetpack_Sitemap_Buffer {
23	/**
24	* Jetpack_Sitemap_Buffer_Video constructor.
25	*
26	* @param int $item_limit The maximum size of the buffer in items.
27	* @param int $byte_limit The maximum size of the buffer in bytes.
28	* @param string $time The initial datetime of the buffer. Must be in 'YYYY-MM-DD hh:mm:ss' format.
29	*/
30	public function __construct( $item_limit, $byte_limit, $time = '1970-01-01 00:00:00' ) {
31	parent::__construct( $item_limit, $byte_limit, $time );
32
33	$this->doc->appendChild(
34	$this->doc->createComment( "generator='jetpack-" . JETPACK__VERSION . "'" )
35	);
36	$this->doc->appendChild(
37	$this->doc->createComment( 'Jetpack_Sitemap_Buffer_Video' )
38	);
39
40	$this->doc->appendChild(
41	$this->doc->createProcessingInstruction(
42	'xml-stylesheet',
43	'type="text/xsl" href="' . $this->finder->construct_sitemap_url( 'video-sitemap.xsl' ) . '"'
44	)
45	);
46	}
47
48	/**
49	* Returns a DOM element that contains all video sitemap elements.
50	*/
51	protected function get_root_element() {
52	if ( ! isset( $this->root ) ) {
53
54	/**
55	* Filter the XML namespaces included in video sitemaps.
56	*
57	* @module sitemaps
58	*
59	* @since 4.8.0
60	*
61	* @param array $namespaces Associative array with namespaces and namespace URIs.
62	*/
63	$namespaces = apply_filters(
64	'jetpack_sitemap_video_ns',
65	array(
66	'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
67	'xsi:schemaLocation' => 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd',
68	'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9',
69	'xmlns:video' => 'http://www.google.com/schemas/sitemap-video/1.1',
70	)
71	);
72
73	$this->root = $this->doc->createElement( 'urlset' );
74
75	foreach ( $namespaces as $name => $value ) {
76	$this->root->setAttribute( $name, $value );
77	}
78
79	$this->doc->appendChild( $this->root );
80	$this->byte_capacity -= strlen( $this->doc->saveXML( $this->root ) );
81	}
82
83	return $this->root;
84	}
85	}
86