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

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

jetpack / modules / sitemaps Last commit date

sitemap-buffer-video-xmlwriter.php

88 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* XMLWriter implementation of the video sitemap buffer.
4	*
5	* @since 14.6
6	* @package automattic/jetpack
7	*/
8
9	/**
10	* A buffer for constructing sitemap video xml files using XMLWriter.
11	*
12	* @since 14.6
13	*/
14	class Jetpack_Sitemap_Buffer_Video_XMLWriter extends Jetpack_Sitemap_Buffer_XMLWriter {
15
16	/**
17	* Initialize the buffer with required headers and root element.
18	*/
19	protected function initialize_buffer() {
20	// Add generator comment
21	$this->writer->writeComment( "generator='jetpack-" . JETPACK__VERSION . "'" );
22	$this->writer->writeComment( 'Jetpack_Sitemap_Buffer_Video_XMLWriter' );
23
24	// Add stylesheet
25	$this->writer->writePi(
26	'xml-stylesheet',
27	'type="text/xsl" href="' . $this->finder->construct_sitemap_url( 'video-sitemap.xsl' ) . '"'
28	);
29
30	// Start root element with namespaces
31	$this->writer->startElement( 'urlset' );
32
33	/**
34	* Filter the XML namespaces included in video sitemaps.
35	*
36	* @module sitemaps
37	*
38	* @since 4.8.0
39	*
40	* @param array $namespaces Associative array with namespaces and namespace URIs.
41	*/
42	$namespaces = apply_filters(
43	'jetpack_sitemap_video_ns',
44	array(
45	'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
46	'xsi:schemaLocation' => 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd',
47	'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9',
48	'xmlns:video' => 'http://www.google.com/schemas/sitemap-video/1.1',
49	)
50	);
51
52	foreach ( $namespaces as $name => $value ) {
53	$this->writer->writeAttribute( $name, $value );
54	}
55	}
56
57	/**
58	* Append a URL entry with video information to the sitemap.
59	*
60	* @param array $array The URL item to append.
61	*/
62	protected function append_item( $array ) {
63	// Return early if missing fundamental data.
64	if ( empty( $array['url']['video:video'] ) ) {
65	return;
66	}
67
68	$this->writer->startElement( 'url' );
69
70	// Add URL elements
71	foreach ( $array['url'] as $url_tag => $url_value ) {
72	if ( $url_tag === 'video:video' ) {
73	// Add video:video element and its children.
74	$this->writer->startElement( 'video:video' );
75	foreach ( $array['url']['video:video'] as $video_tag => $video_value ) {
76	$this->writer->writeElement( $video_tag, strval( $video_value ) );
77	}
78	$this->writer->endElement(); // video
79	} else {
80	// Add other eleents.
81	$this->writer->writeElement( $url_tag, strval( $url_value ) );
82	}
83	}
84
85	$this->writer->endElement(); // url
86	}
87	}
88