KWebAdapter Class Reference

Adapters are used to manipulate different data types (mainly items and objects) in an uniform manner. More...

Inheritance diagram for KWebAdapter:

Public Member Functions
	__construct ($options)
	addOptions ($options, $recursive=false)
	Adds (merges) options.
Static Public Member Functions
static	factory ($genre=false, $options=array())
	Creates new adapter for specified genre.
Data Fields
const	WITH_ID = 'with_id'
	Items with specified ids.
const	WITHOUT_ID = 'without_id'
const	WITH_PARENTS = "with_parents"
	Items with specified parents in the path.
const	WITH_PARENTS_DEPTH = "with_parents_depth"
	Depth of parents check, default 3.
const	WITH_PARENTS_LINKTYPE = "with_parents_linktype"
const	WITH_SECTION = "with_section"
	Items with specified section.
const	WITH_SECTION_DEPTH = "with_section_depth"
	Depth of section check, default 3.
const	WITH_PARENT = "with_parent"
	With specific parent (includes instances, use WITH_LINKTYPE to change that)
const	WITH_LINKTYPE = "with_linktype"
const	WITH_LINKSTATUS = "with_linkstatus"
const	WITH_ATTR_ID = "with_attr_id"
	With specific parent.
const	WITH_STATUS = "with_status"
const	WITH_TYPE = "with_type"
const	WITH_OWNER = "with_owner"
const	WITH_TRANSLATION = "with_translation"
	With specific translation (or true for current language)
const	WITH_KEYWORD = 'with_keyword'
	With specific keywords.
const	QUERY_WITH = 'query_with'
	Adds with statements to the query.
const	QUERY_WITH_EQUALS = 'query_with_equals'
	Adds withEquals statements to the query.
const	IS_PUBLISHED = "is_published"
	Item is published and visible.
const	SELECT_OBJECT_ID = "select_object_id"
	Select item id with using column alias.
const	LIMIT = "limit"
const	OFFSET = "offset"
const	ORDER = "order"
	Order as: IORDER_*, or order keyword, or array for sql builder...
const	ORDER_ATTRIBUTES = "order_attributes"
const	ORDER_PRIORITY = "order_priority"
const	SEARCH = "search"
	Search for text or special keywords.
const	CONTEXT_OBJECT = "context_object"
const	COLLECTION_QUERY = "collection_query"
	Options for Collection_Query.
	$options = array()
	Adapter's options.
Static Protected Attributes
static	$sharedAdapters = array()

---

Detailed Description

Adapters are used to manipulate different data types (mainly items and objects) in an uniform manner.

To acquire Adapter for specific object genre use: KWebAdapter::factory(GENRE_)

There are couple of specific groups of functions:

• read* - for reading items using unified set of options
• build*Query - for building SQL quries using specified set of options
• query* - for modifying existing SQL queries

Some adapters help in accessing database data

---

Constructor & Destructor Documentation

KWebAdapter::__construct

(

$

options

)

---

Member Function Documentation

KWebAdapter::addOptions	(	$	options,
		$	recursive = false
	)

Adds (merges) options.

Parameters:

$recursive

Options are merge recursively

static KWebAdapter::factory	(	$	genre = false,
		$	options = array()
	)		[static]

Creates new adapter for specified genre.

Parameters:

$options

- array of options, or FALSE for using a shared adapter for simple queries, not using options (ie query building)

Returns:

KWebAdapter

---

Field Documentation

KWebAdapter::$options = array()

Adapter's options.

KWebAdapter::$sharedAdapters = array() [static, protected]

const KWebAdapter::COLLECTION_QUERY = "collection_query"

Options for Collection_Query.

const KWebAdapter::CONTEXT_OBJECT = "context_object"

const KWebAdapter::IS_PUBLISHED = "is_published"

Item is published and visible.

const KWebAdapter::LIMIT = "limit"

const KWebAdapter::OFFSET = "offset"

const KWebAdapter::ORDER = "order"

Order as: IORDER_*, or order keyword, or array for sql builder...

const KWebAdapter::ORDER_ATTRIBUTES = "order_attributes"

const KWebAdapter::ORDER_PRIORITY = "order_priority"

const KWebAdapter::QUERY_WITH = 'query_with'

Adds with statements to the query.

const KWebAdapter::QUERY_WITH_EQUALS = 'query_with_equals'

Adds withEquals statements to the query.

const KWebAdapter::SEARCH = "search"

Search for text or special keywords.

const KWebAdapter::SELECT_OBJECT_ID = "select_object_id"

Select item id with using column alias.

const KWebAdapter::WITH_ATTR_ID = "with_attr_id"

With specific parent.

const KWebAdapter::WITH_ID = 'with_id'

Items with specified ids.

const KWebAdapter::WITH_KEYWORD = 'with_keyword'

With specific keywords.

const KWebAdapter::WITH_LINKSTATUS = "with_linkstatus"

const KWebAdapter::WITH_LINKTYPE = "with_linktype"

const KWebAdapter::WITH_OWNER = "with_owner"

const KWebAdapter::WITH_PARENT = "with_parent"

With specific parent (includes instances, use WITH_LINKTYPE to change that)

const KWebAdapter::WITH_PARENTS = "with_parents"

Items with specified parents in the path.

const KWebAdapter::WITH_PARENTS_DEPTH = "with_parents_depth"

Depth of parents check, default 3.

const KWebAdapter::WITH_PARENTS_LINKTYPE = "with_parents_linktype"

const KWebAdapter::WITH_SECTION = "with_section"

Items with specified section.

const KWebAdapter::WITH_SECTION_DEPTH = "with_section_depth"

Depth of section check, default 3.

const KWebAdapter::WITH_STATUS = "with_status"

const KWebAdapter::WITH_TRANSLATION = "with_translation"

With specific translation (or true for current language)

const KWebAdapter::WITH_TYPE = "with_type"

const KWebAdapter::WITHOUT_ID = 'without_id'

---

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

• include/KWebAdapter/KWebAdapter.php