TEC_Changelog_Formatter::format( AutomatticJetpackChangelogChangelog $changelog )

Write a Changelog object to a string.


Parameters

$changelog

(AutomatticJetpackChangelogChangelog) (Required) Changelog object.


Top ↑

Return

(string)


Top ↑

Source

File: bin/class-tec-changelog-formatter.php

	public function format( Changelog $changelog ) {
		$ret = '';

		foreach ( $changelog->getEntries() as $entry ) {
			$timestamp    = $entry->getTimestamp();
			$release_date = null === $timestamp ? $this->get_unreleased_date() : $timestamp->format( $this->date_format );

			$ret .= '### [' . $entry->getVersion() . '] ' . $release_date . "\n\n";

			$prologue = trim( $entry->getPrologue() );
			if ( '' !== $prologue ) {
				$ret .= "\n$prologue\n\n";
			}

			foreach ( $entry->getChanges() as $change ) {
				$text = trim( $change->getContent() );
				if ( '' !== $text ) {
					$ret .= $this->bullet . ' ' . $change->getSubheading() . ' ' . $this->separator . ' ' . $text . "\n";
				}
			}

			$ret = trim( $ret ) . "\n\n";
		}

		$ret = $this->title . "\n\n" . trim( $ret ) . "\n";

		return $ret;
	}