coreOutput Class Reference

Inheritance diagram for coreOutput:

Public Member Functions
	__construct (output $output)
	addCanonicalTag ($urlBit, $seoTitle, $seoTemplate)
	addCSS ($type, $data)
	addMetaTag ($tag, $content, $encode=true, $trimLen=500)
	core_fetchApplicationData ()
	core_initiate ()
	core_setOutputType ($type)
	encodeMetaTagContent ($content, $makeUTF8Safe=false)
	getCanonicalUrl ()
	getMetaTags ($tag='')
	setCacheExpirationSeconds ($seconds='')
	setHeaderCode ($code, $status='')
Data Fields
	$_current_page_title = ''
Protected Member Functions
	addToDocumentHead ($type, $data)
	forceDownload ($bool)
Protected Attributes
	$_canonicalUrl
	$_forceDownload = false
	$_headerCode = 200
	$_headerExpire = 0
	$_headerStatus = 'OK'
	$_metaTags = array()
	$_outputType = 'normal'
	$output

---

Constructor & Destructor Documentation

__construct

(

output $

output

)

Constructor We could use 'extends' and build the registry object up but we need to use the output handler attached to the registry to save spawning new handlers for 'output' which will have different variables saved in navigation, addToHead, etc

public

Parameters:

object

Registry object

Returns:

void

Reimplemented in htmlOutput, and xmlOutput.

---

Member Function Documentation

addCanonicalTag	(	$	urlBit,
		$	seoTitle,
		$	seoTemplate
	)

Add Canonical Tag $output->addCanonicalTag( 'showtopic=xx', 'my-test-topic', 'showtopic' );

public

Parameters:

string	URL bit (showtopic=x)
string	SEO Title (my-test-topic)
string	SEO Template (showtopic)

Returns:

void

addCSS	(	$	type,
		$	data
	)

Add CSS files

public

Parameters:

string	inline or import
string	Data to add

Returns:

void

addMetaTag	(	$	tag,
		$	content,
		$	encode = true,
		$	trimLen = 500
	)

Add meta tag $output->addMetaTag( 'description', 'This is a short description' );

Parameters:

string	$tag	Tag name
string	$content	Tag content
boolean	$encode	Encode content
integer	$trimLen	Length to trim to (default 500)

Returns:

void

See Also:

http://community.invisionpower.com/tracker/issue-22826-case-sensitivity-in-meta-tags/

See Also:

http://community.invisionpower.com/tracker/issue-32572-bbcode-included-in-meta-description

addToDocumentHead	(	$	type,
		$	data
	)		[protected]

Add items into the document head Simple redirect function

protected

Parameters:

string	Type of head item
mixed	Data

Returns:

null

core_fetchApplicationData

(

)

Fetch navigation tabs

Returns:

array

core_initiate

(

)

initiate Function to do global stuff

Returns:

void

core_setOutputType

(

$

type

)

Set output type

Parameters:

string

$type

Output type

Returns:

void

encodeMetaTagContent	(	$	content,
		$	makeUTF8Safe = false
	)

Encodes meta tag content so its safe for readers, etc

Parameters:

string

$content

Meta tag content

Returns:

string

forceDownload

(

$

bool

)

[protected]

Set forced download mode

protected

Parameters:

boolean

getCanonicalUrl

(

)

Fetch Canonical Tag

Returns:

mixed String if an url is availble otherwise FALSE

getMetaTags

(

$

tag = ''

)

Retrieve meta tags

$output->getMetaTags( 'description' ); $output->getMetaTags();

Parameters:

string

$tag

Tag name (optional)

Returns:

mixed Array of meta tags, or meta tag specified if tag name is supplied

setCacheExpirationSeconds

(

$

seconds = ''

)

Set the cache expiration in seconds

public

Parameters:

int	Seconds to expire (60 == 1 minute, etc)

setHeaderCode	(	$	code,
		$	status = ''
	)

Set the header code

public

Parameters:

int	Header code (200/301, etc)
string	[Optional status if omitted, the function will best guess]

---

The documentation for this class was generated from the following file:

• admin/sources/classes/output/formats/coreOutput.php