phpDocumentor GalleryCore
Helpers
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: GalleryChildEntityHelper_simple

Source Location: /modules/core/classes/helpers/GalleryChildEntityHelper_simple.class

Class GalleryChildEntityHelper_simple

Method Summary
void   buildItemQuery()  
void   fetchChildAlbumItemIds()  
void   fetchChildDataItemIds()  
void   fetchChildItemIds()  
void   fetchChildItemIdsIgnorePermissions()  
void   fetchChildItemIdsWithPermission()  
void   fetchDescendentAlbumItemIds()  
void   fetchDescendentItemIds()  
void   fetchLinkableChildItemIdsWithPermission()  
void   fetchParents()  
array   _fetchChildItemIds()   Helper function for getting child ids
array   _fetchDescendentItemIds()   Helper function for getting descendent ids.
array   _getOrderInfo()   If we want to sort, which storage info we need?

[ Top ]
Methods
buildItemQuery  [line 185]

  void buildItemQuery( $baseTable, $baseIdColumn, $baseQuery, $orderBy, $orderDirection, $class, $requiredPermission, $linkableOnly, $userId  )

Parameters:
   $baseTable: 
   $baseIdColumn: 
   $baseQuery: 
   $orderBy: 
   $orderDirection: 
   $class: 
   $requiredPermission: 
   $linkableOnly: 
   $userId: 

API Tags:
See:  GalleryCoreApi::buildItemQuery


[ Top ]
fetchChildAlbumItemIds  [line 108]

  void fetchChildAlbumItemIds( $item, [ $offset = null], [ $count = null], [ $userId = null]  )

Parameters:
   $item: 
   $offset: 
   $count: 
   $userId: 

API Tags:
See:  GalleryCoreApi::fetchChildAlbumItemIds


[ Top ]
fetchChildDataItemIds  [line 96]

  void fetchChildDataItemIds( $item, [ $offset = null], [ $count = null], [ $userId = null]  )

Parameters:
   $item: 
   $offset: 
   $count: 
   $userId: 

API Tags:
See:  GalleryCoreApi::fetchChildDataItemIds


[ Top ]
fetchChildItemIds  [line 84]

  void fetchChildItemIds( $item, [ $offset = null], [ $count = null], [ $userId = null]  )

Parameters:
   $item: 
   $offset: 
   $count: 
   $userId: 

API Tags:
See:  GalleryCoreApi::fetchChildItemIds


[ Top ]
fetchChildItemIdsIgnorePermissions  [line 120]

  void fetchChildItemIdsIgnorePermissions( $item, [ $offset = null], [ $count = null]  )

Parameters:
   $item: 
   $offset: 
   $count: 

API Tags:
See:  GalleryCoreApi::fetchChildItemIdsIgnorePermissions


[ Top ]
fetchChildItemIdsWithPermission  [line 40]

  void fetchChildItemIdsWithPermission( $itemId, $permissionId  )

Parameters:
   $itemId: 
   $permissionId: 

API Tags:
See:  GalleryCoreApi::fetchChildItemIdsWithPermission


[ Top ]
fetchDescendentAlbumItemIds  [line 394]

  void fetchDescendentAlbumItemIds( $item, $offset, $count, $requiredPermission  )

Parameters:
   $item: 
   $offset: 
   $count: 
   $requiredPermission: 

API Tags:
See:  GalleryCoreApi::fetchDescendentAlbumItemIds


[ Top ]
fetchDescendentItemIds  [line 382]

  void fetchDescendentItemIds( $item, $offset, $count, $requiredPermission  )

Parameters:
   $item: 
   $offset: 
   $count: 
   $requiredPermission: 

API Tags:
See:  GalleryCoreApi::fetchDescendentItemIds


[ Top ]
fetchLinkableChildItemIdsWithPermission  [line 62]

  void fetchLinkableChildItemIdsWithPermission( $itemId, $permissionId  )

Parameters:
   $itemId: 
   $permissionId: 

API Tags:
See:  GalleryCoreApi::fetchLinkableChildItemIdsWithPermission


[ Top ]
fetchParents  [line 243]

  void fetchParents( $item, [ $permission = null], [ $filterBreadcrumb = false]  )

Parameters:
   $item: 
   $permission: 
   $filterBreadcrumb: 

API Tags:
See:  GalleryCoreApi::fetchParents


[ Top ]
_fetchChildItemIds  [line 144]

  array _fetchChildItemIds( GalleryItem $item, int $offset, int $count, string $class, string|array $requiredPermission, boolean $linkableOnly, int $userId  )

Helper function for getting child ids

Parameters:
GalleryItem   $item: 
int   $offset:  an offset into the child item list (null for no offset)
int   $count:  a count of how many child items to return (null for unlimited)
string   $class:  a class to restrict children to (eg. 'GalleryAlbumItem')
string|array   $requiredPermission:  a single required permission-id (can be null) or an array or permission-ids
boolean   $linkableOnly:  whether to restrict to linkable items only
int   $userId:  the userid we're doing this for (defaults to active user id)

API Tags:
Return:  GalleryStatus a status code array of item ids
Access:  private


[ Top ]
_fetchDescendentItemIds  [line 301]

  array _fetchDescendentItemIds( GalleryItem $item, int $offset, int $count, string $class, string $requiredPermission  )

Helper function for getting descendent ids.

Parameters:
GalleryItem   $item: 
int   $offset:  an offset into the child item list (null for no offset)
int   $count:  a count of how many child items to return (null for unlimited)
string   $class:  a class to restrict children to (eg. 'GalleryAlbumItem')
string   $requiredPermission:  a required permission (defaults to 'core.view')

API Tags:
Return:  GalleryStatus a status code array of ids
Access:  private


[ Top ]
_getOrderInfo  [line 421]

  array _getOrderInfo( string $orderBy, string $orderDirection  )

If we want to sort, which storage info we need?

This will return the ORDER BY clause to sort the items and a condition that we need to add to the fetching query. To join with a new table, the [GalleryChildEntity::id] will contain the current ID. Eventually another table mentioned in the condition will have to be included too, the calling function has to decide that (using GalleryStorage::extractClasses())

Parameters:
string   $orderBy:  orderBy (null/empty to use site default for both parameters)
string   $orderDirection:  orderDirection

API Tags:
Return:  GalleryStatus a status code string order by clause, string select clause, string a row matching condition, string optional join clause
Access:  private


[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:54:12 -0700 by phpDocumentor 1.3.0RC6