KWeb  6.4
KWebAdapter_Item Class Reference
Inheritance diagram for KWebAdapter_Item:
KWebAdapter_ItemBase KWebAdapter_ObjectBase_Query KWebAdapter_ObjectBase KWebAdapter KWebAdapter_IReader KWebAdapter_IWriter

Public Member Functions

 getObjectGenre ()
 getObjectIdField ()
 queryBuilder ($queryType=true, $db=false)
 queryFromItem (KWebQueryBuilder $qb, $columns=false, $alias=true)
 Adds k_item table to the query with specified columns and alias.
 queryFromItemLanguage (KWebQueryBuilder $qb, $columns=false, $alias=true, $mainLanguageOnly=true)
 Adds k_item_lang table to the query with specified columns and alias.
 queryFromItemDataTable (KWebQueryBuilder $qb, $table, $columns=false, $mainLanguageOnly=true, $itemIdColumn= 'item_id', $itemLangColumn= 'item_lang')
 Adds object table to the query with specified columns and alias.
 queryUseItem (KWebQueryBuilder $qb)
 Returns k_item alias.
 queryUseItemLanguage (KWebQueryBuilder $qb, $mainLanguageOnly=true)
 Returns k_item_lang alias.
 queryUseItemDataTable (KWebQueryBuilder $qb, $table, $mainLanguageOnly=true, $itemIdColumn= 'item_id', $itemLangColumn= 'item_lang')
 Returns k_item_lang alias.
 queryWhereIsMainLanguage (KWebQueryBuilder $qb, $languageColumn)
 Limits result to rows in item's main language.
 queryWhereIsPublishedVersion (KWebQueryBuilder $qb, $needLanguage=null)
 Limits result to published versions.
 queryWhereStatusEquals (KWebQueryBuilder $qb, $status)
 Limits result to rows with specified status.
 queryWhereIsType (KWebQueryBuilder $qb, $type)
 Limits result to rows with specified item type.
 queryWhereTranslationExists (KWebQueryBuilder $qb, $needLanguage=null, $itemsInMainLanguageOnly=true, $itemTable=false)
 Limits result to items with specific translations.
 queryWhereHasParents (KWebQueryBuilder $qb, $parent, $recurrence=3, $linkType=LINK_INSTANCE)
 Limits result to items with the specified parents in the path.
 queryWhereHasSection (KWebQueryBuilder $qb, $section, $recurrence=3)
 Limits result to items with the specified parents in the path.
 queryWhereHasParent (KWebQueryBuilder $qb, $parentId, $linkType=LINK_STANDARD)
 Limits result to items with specific translations.
 queryOrder (KWebQueryBuilder $qb, $order, $usePriority=true)
 Item order.
 querySelectItemId (KWebQueryBuilder $qb, $select=true, $itemAlias=true, $structureAlias=false, $languageAlias=false, $mainLanguageOnly=true, $dataTable=false)
 Creates basic SELECT for item IDs.
 buildReadQuery ()
 applyQueryOptions (SqlQueryBuilder $qb)
 Applies all query specific options on the query.

Static Public Member Functions

static itemFactory ($options=array())
static inst ()

Data Fields

const ALIAS_ITEM = 'i'
const ALIAS_ITEM_LANG = 'l'

Member Function Documentation

KWebAdapter_Item::applyQueryOptions ( SqlQueryBuilder qb)

Applies all query specific options on the query.

Reimplemented from KWebAdapter_ObjectBase_Query.

KWebAdapter_Item::buildReadQuery ( )
KWebAdapter_Item::getObjectGenre ( )

Reimplemented from KWebAdapter_ObjectBase.

KWebAdapter_Item::getObjectIdField ( )

Reimplemented from KWebAdapter_ObjectBase.

static KWebAdapter_Item::inst ( ) [static]
static KWebAdapter_Item::itemFactory ( options = array()) [static]
KWebAdapter_Item::queryBuilder ( queryType = true,
db = false 
)
KWebAdapter_Item::queryFromItem ( KWebQueryBuilder qb,
columns = false,
alias = true 
)

Adds k_item table to the query with specified columns and alias.

Knows how to join with:

Parameters:
$columns- TRUE becomes 'item_id', default none
$alias- default 'i'
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryFromItemDataTable ( KWebQueryBuilder qb,
table,
columns = false,
mainLanguageOnly = true,
itemIdColumn = 'item_id',
itemLangColumn = 'item_lang' 
)

Adds object table to the query with specified columns and alias.

Knows how to join with: k_item

Parameters:
$table- 'tablename', array('alias' => 'tablename'), 'tablename AS alias'
$columns- default none
$mainLanguageOnly- joins only main languages...
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryFromItemLanguage ( KWebQueryBuilder qb,
columns = false,
alias = true,
mainLanguageOnly = true 
)

Adds k_item_lang table to the query with specified columns and alias.

Knows how to join with:

Parameters:
$columns- TRUE becomes 'item_id', default none
$alias- default 'i'
$mainLanguageOnly- joins only main languages...
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryOrder ( KWebQueryBuilder qb,
order,
usePriority = true 
)

Item order.

Returns:
KWebAdapter_Item
KWebAdapter_Item::querySelectItemId ( KWebQueryBuilder qb,
select = true,
itemAlias = true,
structureAlias = false,
languageAlias = false,
mainLanguageOnly = true,
dataTable = false 
)

Creates basic SELECT for item IDs.

Parameters:
$selectFields to select (default: i.item_id)
$i_prefixk_item table prefix to use (default: 'i', if ===true: 'i')
$structurek_structure table prefix to use, or false to omit this table entirely (default: false, if === true: 's')
$langk_item_lang table prefix to use, or false to omit this table (default: false, if === true: 'l')
$langOnlyadditional constraint for language table (default: true - only main item language is selected)
$dataTabledata table to join as "table prefix" or "table" (default: false)
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryUseItem ( KWebQueryBuilder qb)

Returns k_item alias.

Joins the table if needed

Returns:
string
KWebAdapter_Item::queryUseItemDataTable ( KWebQueryBuilder qb,
table,
mainLanguageOnly = true,
itemIdColumn = 'item_id',
itemLangColumn = 'item_lang' 
)

Returns k_item_lang alias.

Joins the table if needed

Returns:
string
KWebAdapter_Item::queryUseItemLanguage ( KWebQueryBuilder qb,
mainLanguageOnly = true 
)

Returns k_item_lang alias.

Joins the table if needed

Returns:
string
KWebAdapter_Item::queryWhereHasParent ( KWebQueryBuilder qb,
parentId,
linkType = LINK_STANDARD 
)

Limits result to items with specific translations.

Parameters:
$needLanguageFalse: All items, True: Only items with translation in current language , Language id: Only items with this language translation, NULL: default behaviour
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereHasParents ( KWebQueryBuilder qb,
parent,
recurrence = 3,
linkType = LINK_INSTANCE 
)

Limits result to items with the specified parents in the path.

See also:
KWebItem::getSqlWithParents
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereHasSection ( KWebQueryBuilder qb,
section,
recurrence = 3 
)

Limits result to items with the specified parents in the path.

See also:
KWebItem::getSqlWithParents
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereIsMainLanguage ( KWebQueryBuilder qb,
languageColumn 
)

Limits result to rows in item's main language.

Parameters:
$languageColumnColumn to compare with item_main_lang
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereIsPublishedVersion ( KWebQueryBuilder qb,
needLanguage = null 
)

Limits result to published versions.

Parameters:
$needLanguageFalse: All items, True: Only items with translation in current language , Language id: Only items with this language translation, NULL: default behaviour
Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereIsType ( KWebQueryBuilder qb,
type 
)

Limits result to rows with specified item type.

Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereStatusEquals ( KWebQueryBuilder qb,
status 
)

Limits result to rows with specified status.

Returns:
KWebAdapter_Item
KWebAdapter_Item::queryWhereTranslationExists ( KWebQueryBuilder qb,
needLanguage = null,
itemsInMainLanguageOnly = true,
itemTable = false 
)

Limits result to items with specific translations.

Parameters:
$needLanguageFalse: All items, True: Only items with translation in current language , Language id: Only items with this language translation, NULL: default behaviour
Returns:
KWebAdapter_Item

Field Documentation


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