IP.Board  3.3.0
feed_blogs Class Reference
Inheritance diagram for feed_blogs:
feedBlockInterface feedBlockInterface

Public Member Functions

 __construct (ipsRegistry $registry)
 __construct (ipsRegistry $registry)
 checkFeedContentTypes ($data)
 checkFeedContentTypes ($data)
 checkFeedFilters ($session, $data)
 checkFeedFilters ($session, $data)
 checkFeedOrdering ($data, $session)
 checkFeedOrdering ($data, $session)
 executeFeed ($block, $previewMode=false)
 executeFeed ($block, $previewMode=false)
 getTags ($info='')
 getTags ($info='')
 returnContentTypes ($session=array(), $asHTML=true)
 returnContentTypes ($session=array(), $asHTML=true)
 returnFeedInfo ()
 returnFeedInfo ()
 returnFilters ($session)
 returnFilters ($session)
 returnOrdering ($session)
 returnOrdering ($session)
 returnTemplateGalleryKeys ($feed_type, $content_type)
 returnTemplateGalleryKeys ($feed_type, $content_type)

Protected Member Functions

 _addMemberColumns (&$_finalColumns, &$_noinfoColumns)
 _addMemberColumns (&$_finalColumns, &$_noinfoColumns)

Protected Attributes

 $cache
 $caches
 $DB
 $lang
 $member
 $memberData
 $registry
 $request
 $settings

Constructor & Destructor Documentation

__construct ( ipsRegistry registry)

#@- Constructor

public

Parameters:
objectRegistry reference
Returns:
void
__construct ( ipsRegistry registry)

#@- Constructor

public

Parameters:
objectRegistry reference
Returns:
void

Member Function Documentation

_addMemberColumns ( &$  _finalColumns,
&$  _noinfoColumns 
) [protected]

Appends member columns to existing arrays

protected

Parameters:
arrayColumns that have descriptions
arrayColumns that do not have descriptions
Returns:
void [Params are passed by reference and modified]
_addMemberColumns ( &$  _finalColumns,
&$  _noinfoColumns 
) [protected]

Appends member columns to existing arrays

protected

Parameters:
arrayColumns that have descriptions
arrayColumns that do not have descriptions
Returns:
void [Params are passed by reference and modified]
checkFeedContentTypes ( data)

Check the feed content type selection

public

Parameters:
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Content type data to use )

Implements feedBlockInterface.

checkFeedContentTypes ( data)

Check the feed content type selection

public

Parameters:
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Content type data to use )

Implements feedBlockInterface.

checkFeedFilters ( session,
data 
)

Check the feed filters selection

public

Parameters:
arraySession data
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Content type data to use )

Implements feedBlockInterface.

checkFeedFilters ( session,
data 
)

Check the feed filters selection

public

Parameters:
arraySession data
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Content type data to use )

Implements feedBlockInterface.

checkFeedOrdering ( data,
session 
)

Check the feed ordering options

public

Parameters:
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Ordering data to use )

Implements feedBlockInterface.

checkFeedOrdering ( data,
session 
)

Check the feed ordering options

public

Parameters:
arraySubmitted data to check (usually $this->request)
Returns:
array Array( (bool) Ok or not, (array) Ordering data to use )

Implements feedBlockInterface.

executeFeed ( block,
previewMode = false 
)

Execute the feed and return the HTML to show on the page. Can be called from ACP or front end, so the plugin needs to setup any appropriate lang files, skin files, etc.

public

Parameters:
arrayBlock data
boolPreview mode
Returns:
string Block HTML to display or cache

Implements feedBlockInterface.

executeFeed ( block,
previewMode = false 
)

Execute the feed and return the HTML to show on the page. Can be called from ACP or front end, so the plugin needs to setup any appropriate lang files, skin files, etc.

public

Parameters:
arrayBlock data
boolPreview mode
Returns:
string Block HTML to display or cache

Implements feedBlockInterface.

getTags ( info = '')

Return the tag help for this block type

public

Parameters:
stringAdditional info (database id;type)
Returns:
array
getTags ( info = '')

Return the tag help for this block type

public

Parameters:
stringAdditional info (database id;type)
Returns:
array
returnContentTypes ( session = array(),
asHTML = true 
)

Get the feed's available content types. Returns form elements and data

Parameters:
arraySession data
arraytrue: Return an HTML radio list; false: return an array of types
Returns:
array Form data

Implements feedBlockInterface.

returnContentTypes ( session = array(),
asHTML = true 
)

Get the feed's available content types. Returns form elements and data

Parameters:
arraySession data
arraytrue: Return an HTML radio list; false: return an array of types
Returns:
array Form data

Implements feedBlockInterface.

Return the plugin meta data

public

Returns:
array Plugin data (key (folder name), associated app, name, description, hasFilters, templateBit)

Implements feedBlockInterface.

Return the plugin meta data

public

Returns:
array Plugin data (key (folder name), associated app, name, description, hasFilters, templateBit)

Implements feedBlockInterface.

returnFilters ( session)

Get the feed's available filter options. Returns form elements and data

public

Parameters:
arraySession data
Returns:
array Form data

Implements feedBlockInterface.

returnFilters ( session)

Get the feed's available filter options. Returns form elements and data

public

Parameters:
arraySession data
Returns:
array Form data

Implements feedBlockInterface.

returnOrdering ( session)

Get the feed's available ordering options. Returns form elements and data

public

Parameters:
arraySession data
Returns:
array Form data

Implements feedBlockInterface.

returnOrdering ( session)

Get the feed's available ordering options. Returns form elements and data

public

Parameters:
arraySession data
Returns:
array Form data

Implements feedBlockInterface.

returnTemplateGalleryKeys ( feed_type,
content_type 
)

Provides the ability to modify the feed type or content type values before they are passed into the gallery template search query

public

Parameters:
stringCurrent feed type
stringCurrent content type
Returns:
array Array with two keys: feed_type and content_type
returnTemplateGalleryKeys ( feed_type,
content_type 
)

Provides the ability to modify the feed type or content type values before they are passed into the gallery template search query

public

Parameters:
stringCurrent feed type
stringCurrent content type
Returns:
array Array with two keys: feed_type and content_type

The documentation for this class was generated from the following files:
 All Data Structures Functions Variables