Qvcdoc Class Reference

Public Member Functions
	add_bcc ($addr, $name='')
	add_cc ($addr, $name='')
	add_recipient ($addr, $name='')
	body ()
	render_as_block ($label, $lang=null)
	load ($label, $lang=null)
	mail ()
	replace ($pattern, $replacement)
	replace_subject ($pattern, $replacement)
	set_from ($addr, $name=null)
	subject ()
	title ()

Detailed Description

Implements the Qvcdoc class, which provides document and email templates.

Member Function Documentation

Qvcdoc::add_bcc	(		$addr,
			$name = ''
	)

Add a bcc recipient

Parameters

string	$addr
string	$name

Returns

Qvcdoc

Qvcdoc::add_cc	(		$addr,
			$name = ''
	)

Add a cc recipient

Parameters

string	$addr
string	$name

Returns

Qvcdoc

Qvcdoc::add_recipient	(		$addr,
			$name = ''
	)

Add a "to" recipient

Parameters

string	$addr
string	$name

Returns

Qvcdoc

Qvcdoc::body

(

)

Return the current document body

Returns

string

Qvcdoc::load	(		$label,
			$lang = null
	)

Load the document with the given label. If the language then attempt to load that language, otherwise use the current active language.

Parameters

string	$label
string	$lang	- en or fr

Returns

Qvcdoc

Qvcdoc::mail

(

)

Mail a document

Qvcdoc::render_as_block	(		$label,
			$lang = null
	)

Render a document as a block.

Parameters

string	$label
string	$lang

Qvcdoc::replace	(		$pattern,
			$replacement
	)

Replace text in the current document body

Parameters

string	$pattern
string	$replacement

Returns

Qvcdoc

Qvcdoc::replace_subject	(		$pattern,
			$replacement
	)

Replace text in the current document subject

Parameters

string	$pattern
string	$replacement

Returns

Qvcdoc

Qvcdoc::set_from	(		$addr,
			$name = null
	)

Set the email "from" address and name

Parameters

string	$addr
string	$name

Qvcdoc::subject

(

)

Return the current document subject

Returns

string

Qvcdoc::title

(

)

Return the current document title

Returns

string

---

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

• qvci/libraries/Qvcdoc.php