Inheritance diagram for GenericVCardHandler:

Public Member Functions
	__construct ($path_type)

	initialise ($params=array())

	get_vCardAvailableVersions ()

	get_vCardDefaultParams ()

	get_pluginError ()

	check_vCardVersion ($content)

Public Member Functions inherited from Input
	__construct ($name, $path_type)

	Input ($name, $path_type)

	display ()

	get_translation ($value, $data=null)

	set_selectedLayout ($layout='')

Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)

	get_version ()

	load_library ($library='')

	load_file ($file='')

	load_varFile ($file='')

	load_engineFile ($file='')

	get_engineFileURL ($file='', $path=false)

	get_fileURL ($file='', $path=null, $default='')

	get_varFileURL ($file='', $path=false, $default='')

	get_filePath ($file='')

	get_varFilePath ($file='')

	add_JSFile ($file)

	add_JSEngineFile ($file)

	add_JSExternFile ($file)

	add_JSScript ($script, $unique=false)

	add_JSPreScript ($script, $unique=false)

	add_JSWindowEventScript ($event, $script, $unique=false)

	add_JSLoadScript ($script, $unique=false)

	add_JSUnloadScript ($script, $unique=false)

	add_styleFile ($file, $media='', $condition='')

	add_styleScript ($css)

	add_styleIncludedFile ($file)

	add_StyleExternFile ($file, $media='', $condition='')

	set_RSSFeed ($title, $url)

	add_headerExtra ($content='')

	install ()

	uninstall ()

	is_installed ()

	update ($version, $more='')

	add_translation ($more='', $lg=null)

	get_languages ()

	execute_onCaMykSInitialise ()

	execute_onCaMykSPageLoad ()

	execute_onCaMykSBodyOpen ()

	execute_onCaMykSBodyClose ()

	execute_onCaMykSAdminPageLoad ()

	execute_onCaMykSAdminBodyOpen ()

	execute_onCaMykSAdminBodyClose ()

	execute_onCaMykSTerminate ()

	get_requestLink ($params=array())

	get_requestJSLink ($params=array())

	execute_request ()

	get_varFile ($file)

Private Member Functions
	export_vCard ($params)

	import_vCard ($params)

	get_exportDefaultParams ()

	get_importDefaultParams ()

	load_vCardObject ($version='')

	encode_cardTitle ($title)

	define_pluginError ($error, $param=null)

	getCountryCode ($code)

Static Private Member Functions
static	Unescape ($Text)

static	cleanVcard ($content)

Private Attributes
	$loadedObjects = array()
	Loaded vcard format list. More...

	$pluginError = ''
	Last error. More...

Additional Inherited Members
Public Attributes inherited from Input
	$title
	Input title. More...

	$params = array()
	Input parameters. More...

	$selected_layout = 'input.html.inc'
	Input layout to use. More...

Public Attributes inherited from Plugin
	$name
	Plugin name. More...

	$version
	Plugin version. More...

	$active = false
	Plugin installation status. More...

	$plugin_package = ''
	Plugin package. More...

	$plugin_type
	Plugin type. More...

	$object_type
	Plugin type. More...

	$plugin_path
	Plugin path. More...

	$plugin_site_path
	Plugin site path (for element overwriting). More...

	$plugin_var_path
	Plugin var path. More...

	$plugin_url
	Plugin URL. More...

	$plugin_site_url
	Plugin site URL (for element overwriting). More...

	$plugin_var_url
	Plugin var URL. More...

	$path_type
	Plugin path type. More...

	$author_name
	Plugin author name. More...

	$author_mail
	Plugin author email. More...

	$author_group
	Plugin author group. More...

	$plugin_dependencies = array()
	Plugin dependencies. More...

Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')

	add_meta ($name, $content, $method='name')

	add_toHtaccess ($content='')

	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)

	set_dependencies ()

	register_asSharedObject ($name)

&	get_sharedObject ($name)

	register_asExtension ($plugin)

	get_registeredExtensions ()

	register_asCaMykSEventHandler ($event)

Detailed Description

SyntaxColoringEngine Input class.

Constructor & Destructor Documentation

◆ __construct()

GenericVCardHandler::__construct ( $path_type )

Class constructor.

Parameters

string $path_type

Returns: void

Member Function Documentation

◆ initialise()

GenericVCardHandler::initialise ( $params = array() )

Initialise input.

Parameters

array $params

Returns: boolean result

Reimplemented from Input.

◆ export_vCard()

GenericVCardHandler::export_vCard ( $params )

private

Export vCard.

Parameters

array $params

Returns: mixed

◆ import_vCard()

GenericVCardHandler::import_vCard ( $params )

private

Import vCard.

Parameters

array $params

Returns: mixed

◆ get_vCardAvailableVersions()

GenericVCardHandler::get_vCardAvailableVersions ( )

Return vCard available versions.

Returns: array

◆ get_vCardDefaultParams()

GenericVCardHandler::get_vCardDefaultParams ( )

Return vCard default params.

Returns: array

◆ get_exportDefaultParams()

GenericVCardHandler::get_exportDefaultParams ( )

private

return export action params.

Returns: array

◆ get_importDefaultParams()

GenericVCardHandler::get_importDefaultParams ( )

private

Return import action params.

Returns: array

◆ load_vCardObject()

GenericVCardHandler::load_vCardObject ( $version = '' )

private

Load vCard object.

Parameters

string $version

Returns: void

◆ encode_cardTitle()

GenericVCardHandler::encode_cardTitle ( $title )

private

Return encoded title.

Parameters

string $title

Returns: string

◆ define_pluginError()

GenericVCardHandler::define_pluginError	(	$error,
		$param = `null`
	)

private

Define plugin error.

Parameters

string	$error
mixed	$param

Returns: void

◆ get_pluginError()

GenericVCardHandler::get_pluginError ( )

Return plugin error.

Returns: string

◆ getCountryCode()

GenericVCardHandler::getCountryCode ( $code )

private

Method to get country code from title

Parameters

string $code

Returns: string

◆ check_vCardVersion()

GenericVCardHandler::check_vCardVersion ( $content )

Check if the given content is a genuine vCard

Parameters

unknown $content

Todo:

add support for xCard, jCard, hCard

Check for mandatory attributes (BEGIN,END, etc...)

Returns: vCard version

◆ Unescape()

static GenericVCardHandler::Unescape ( $Text )

staticprivate

Unescape text/

Todo:

verify this method doesnt exist somewhere else

refactor it, put it somewhere higher

Parameters

string $Text to prepare.

Returns: string Resulting text.

◆ cleanVcard()

static GenericVCardHandler::cleanVcard ( $content )

staticprivate

Clean the vCard.

Parameters

string $content

Returns: string

Member Data Documentation

◆ $loadedObjects

GenericVCardHandler::$loadedObjects = array()

private

Loaded vcard format list.

var array $loadedObjects

◆ $pluginError

GenericVCardHandler::$pluginError = ''

private

Last error.

var string $pluginError

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

CaMykS/plugin/input/GenericVCardHandler/GenericVCardHandler.php.inc

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ initialise()

◆ export_vCard()

◆ import_vCard()

◆ get_vCardAvailableVersions()

◆ get_vCardDefaultParams()

◆ get_exportDefaultParams()

◆ get_importDefaultParams()

◆ load_vCardObject()

◆ encode_cardTitle()

◆ define_pluginError()

◆ get_pluginError()

◆ getCountryCode()

◆ check_vCardVersion()

◆ Unescape()

◆ cleanVcard()

Member Data Documentation

◆ $loadedObjects

◆ $pluginError