PhabricatorMarkupInterface.php
No OneTemporary
Actions

Size

3 KB

Referenced Files

None

Subscribers

None

PhabricatorMarkupInterface.php
View Options

	<?php

	/*
	* Copyright 2012 Facebook, Inc.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	/**
	* An object which has one or more fields containing markup that can be
	* rendered into a display format. Commonly, the fields contain Remarkup and
	* are rendered into HTML. Implementing this interface allows you to render
	* objects through @{class:PhabricatorMarkupEngine} and benefit from caching
	* and pipelining infrastructure.
	*
	* An object may have several "fields" of markup. For example, Differential
	* revisions have a "summary" and a "test plan". In these cases, the `$field`
	* parameter is used to identify which field is being operated on. For simple
	* objects like comments, you might only have one field (say, "body"). In
	* these cases, the implementation can largely ignore the `$field` parameter.
	*
	* @task markup Markup Interface
	*
	* @group markup
	*/
	interface PhabricatorMarkupInterface {


	/* -( Markup Interface )--------------------------------------------------- */


	/**
	* Get a key to identify this field. This should uniquely identify the block
	* of text to be rendered and be usable as a cache key. If the object has a
	* PHID, using the PHID and the field name is likley reasonable:
	*
	* "{$phid}:{$field}"
	*
	* @param string Field name.
	* @return string Cache key.
	*
	* @task markup
	*/
	public function getMarkupFieldKey($field);


	/**
	* Build the engine the field should use.
	*
	* @param string Field name.
	* @return PhutilRemarkupEngine Markup engine to use.
	* @task markup
	*/
	public function newMarkupEngine($field);


	/**
	* Return the contents of the specified field.
	*
	* @param string Field name.
	* @return string The raw markup contained in the field.
	* @task markup
	*/
	public function getMarkupText($field);


	/**
	* Callback for final postprocessing of output. Normally, you can return
	* the output unmodified.
	*
	* @param string Field name.
	* @param string The finalized output of the engine.
	* @param string The engine which generated the output.
	* @return string Final output.
	* @task markup
	*/
	public function didMarkupText(
	$field,
	$output,
	PhutilMarkupEngine $engine);


	/**
	* Determine if the engine should try to use the markup cache or not.
	* Generally you should use the cache for durable/permanent content but
	* should not use the cache for temporary/draft content.
	*
	* @return bool True to use the markup cache.
	* @task markup
	*/
	public function shouldUseMarkupCache($field);

	}

File Metadata

Mime Type: text/x-php
Expires: Jan 19 2025, 21:57 (6 w, 2 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1129164
Default Alt Text: PhabricatorMarkupInterface.php (3 KB)

PhabricatorMarkupInterface.phpNo OneTemporaryActions

PhabricatorMarkupInterface.phpView Options

File Metadata

Event Timeline

PhabricatorMarkupInterface.php
No OneTemporary
Actions

PhabricatorMarkupInterface.php
View Options