WPSEO_Collector{} │ Yoast 1.0

Collects the data from the added collection objects.

Хуков нет.

Использование

$WPSEO_Collector = new WPSEO_Collector();
// use class methods

Методы

1. public add_collection( WPSEO_Collection $collection )
2. public collect()
3. public get_as_json()

Код WPSEO_Collector{} WPSEO Collector{} ^{Yoast 26.5}

class WPSEO_Collector {

	/**
	 * Holds the collections.
	 *
	 * @var WPSEO_Collection[]
	 */
	protected $collections = [];

	/**
	 * Adds a collection object to the collections.
	 *
	 * @param WPSEO_Collection $collection The collection object to add.
	 *
	 * @return void
	 */
	public function add_collection( WPSEO_Collection $collection ) {
		$this->collections[] = $collection;
	}

	/**
	 * Collects the data from the collection objects.
	 *
	 * @return array The collected data.
	 */
	public function collect() {
		$data = [];

		foreach ( $this->collections as $collection ) {
			$data = array_merge( $data, $collection->get() );
		}

		return $data;
	}

	/**
	 * Returns the collected data as a JSON encoded string.
	 *
	 * @return string|false The encode string.
	 */
	public function get_as_json() {
		return WPSEO_Utils::format_json_encode( $this->collect() );
	}
}