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

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

jetpack / modules / sitemaps Last commit date

sitemap-buffer-video-xmlwriter.php

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