Static Public Member Functions
static	addAttachment ($connection, $list_id, $list_item_id, $file_name, $base64Binary)

static	checkOutFile ($page_url, $last_modified='')

static	getWSDLLocation ($service_name, $url_root)

static	getUserInfo ($user_name='administrator')

static	getPermissionCollection ($list_name)

static	deleteList ($list_name)

static	addList ($list_name, $description='', $templateID='100')

static	getList ($connection, $list_id)

static	getListAvailableFields ($connection, $list_id, $all=FALSE, $get_field_info=FALSE)

static	deleteListItem ($list_id, $list_item_id)

static	addListItem ($connection, $list_id, $sharepoint_fields)

static	getListItems ($connection, $list_id, $search_query=Array(), $search_logic='And', $row_limit='', $download_file=FALSE, $bridge_info="")

static	getListCollections ($connection, $custom_list_only=FALSE)

static	getListNames ($connection, $all_list_details=Array())

static	test_sharepoint_connection ($connection, $silent=FALSE)

Detailed Description

+-----------------------------------------------------------------—+ | This MySource Matrix CMS file is Copyright (c) Squiz Pty Ltd | | ACN 084 670 600 | +-----------------------------------------------------------------—+ | IMPORTANT: Your use of this Software is subject to the terms of | | the Licence provided in the file licence.txt. If you cannot find | | this file please contact Squiz (www.squiz.com.au) so we may provide| | you a copy. | +-----------------------------------------------------------------—+

Id:: sharepoint_common.inc,v 1.11 2012/08/30 00:59:19 ewang Exp

Definition at line 30 of file sharepoint_common.inc.

Member Function Documentation

static addAttachment	(	$connection,
		$list_id,
		$list_item_id,
		$file_name,
		$base64Binary
	)

static

This is used to attach a file onto a sharepoint list item, and it can only be used on a custom list

Returns: void public

Definition at line 40 of file sharepoint_common.inc.

static addList	(	$list_name,
		$description = `''`,
		$templateID = `'100'`
	)

static

This function add a new List into sharepoint

Parameters

string	$list_name	The name of the list being added
string	$description	The description for the list
string	$templateID	The templateID from the sharepoint system

Returns: boolean public

Definition at line 236 of file sharepoint_common.inc.

static addListItem	(	$connection,
		$list_id,
		$sharepoint_fields
	)

static

This function add a list item to a list (preferably a custom list)

Parameters

array	$connection	The connection information
string	$list_id	The ID of the list we are trying to get information for
array	$sharepoint_fields	The fields we are specifying values for

Returns: boolean public

Definition at line 428 of file sharepoint_common.inc.

static checkOutFile	(	$page_url,
		$last_modified = `''`
	)

static

This function is used to check out a file from Sharepoint / mark a file as checked out

Returns: void public

Definition at line 73 of file sharepoint_common.inc.

static deleteList ( $list_name )

static

Delete a sharepoint list

Parameters

string $list_name The name of the list being deleted

Returns: boolean public

Definition at line 208 of file sharepoint_common.inc.

static deleteListItem	(	$list_id,
		$list_item_id
	)

static

This function delete a list item from a list

Parameters

string	$list_id	The ID of the list we are deleting items from
string	$list_item_id	The item ID we are trying to delete

Returns: boolean public

Definition at line 388 of file sharepoint_common.inc.

static getList	(	$connection,
		$list_id
	)

static

This function return the details of a list. The details would include all the attributes and fields of the list, this is useful when trying to create a new list item in a list that its structure if unknown.

Parameters

array	$connection	The connection information
string	$list_id	The ID of the list we are trying to get information for

Returns: string public

Definition at line 304 of file sharepoint_common.inc.

static getListAvailableFields	(	$connection,
		$list_id,
		$all = `FALSE`,
		$get_field_info = `FALSE`
	)

static

This function return all the available fields for a particular list

Parameters

array	$connection	The connection information
string	$list_id	The ID of the list we are trying to get information for
bool	$all	Get all fields or non-read-only fields
bool	$get_field_info	Get fields information

Returns: array public

Definition at line 337 of file sharepoint_common.inc.

static getListCollections	(	$connection,
		$custom_list_only = `FALSE`
	)

static

This function is used return all the list available in the system

Returns: array public

Definition at line 697 of file sharepoint_common.inc.

static getListItems	(	$connection,
		$list_id,
		$search_query = `Array()`,
		$search_logic = `'And'`,
		$row_limit = `''`,
		$download_file = `FALSE`,
		$bridge_info = `""`
	)

static

This function is used to search for list items within a sharepoint list An XML query can be provided to set the criterions of the search based on item's fields

Parameters

$search_info array The fields criterions to search for

Returns: array public

Definition at line 588 of file sharepoint_common.inc.

static getListNames	(	$connection,
		$all_list_details = `Array()`
	)

static

This function get all list name from Sharepoint

Parameters

array	$connection	The connection information
array	$all_list_details	The list details, if already gotten from somewhere else

Returns: array public

Definition at line 737 of file sharepoint_common.inc.

static getPermissionCollection ( $list_name )

static

This function return the permission collection for a list or a site

Parameters

string $list_name The name of the list we are trying to get the permission collection

Returns: array public

Definition at line 180 of file sharepoint_common.inc.

static getUserInfo ( $user_name = 'administrator' )

static

This function return the information about a particular user

Parameters

string $user_name The username of the user we are getting information for

Returns: array public

Definition at line 152 of file sharepoint_common.inc.

static getWSDLLocation	(	$service_name,
		$url_root
	)

static

This function is used to return the WSDL location of a particular service

Returns: string public

Definition at line 100 of file sharepoint_common.inc.

static test_sharepoint_connection	(	$connection,
		$silent = `FALSE`
	)

static

This function test whether a connection is valid

Parameters

array $connection The connection information

Returns: boolean public

Definition at line 803 of file sharepoint_common.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/sharepoint/lib/sharepoint_common.inc

Static Public Member Functions

Detailed Description

Member Function Documentation