This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Controller_Block_Guestbook

Controller for the guestbook block, which allows site owners to add comments onto any concrete page.

Concrete5_Library_Controller
Extended by Controller
Extended by Concrete5_Library_BlockController
Extended by BlockController
Extended by Concrete5_Controller_Block_Guestbook

Direct known subclasses

GuestbookBlockController

Package: Blocks\Guestbook
Copyright: Copyright (c) 2003-2012 Concrete5. (http://www.concrete5.org)
License: MIT License
Author: Ryan Tyler ryan@concrete5.org
Author: Andrew Embler andrew@concrete5.org
Located at core/controllers/blocks/guestbook.php

Methods summary

public string
# getBlockTypeDescription( )

Used for localization. If we want to localize the name/description we have to include this

public string
# getBlockTypeName( )

Returns the name of the block type

public
# delete( )

Automatically run when a block is deleted. This removes the special data from the block's specific database table. If a block needs to do more than this this method should be overridden.

public string
# getTitle( )

returns the title

public boolean
# getRequireApproval( )

returns wether or not to require approval

public boolean
# getDisplayGuestBookForm( )

returns the bool to display the form

public
# action_form_save_entry( )

Handles the form post for adding a new guest book entry

public array
# getEntries( string $order = "ASC" )

gets a list of all guestbook entries for the current block

public boolean
# action_loadEntry( )

Loads a guestbook entry and sets the $Entry GuestBookBlockEntry object instance for use by the view

public
# action_removeEntry( )

deltes a given Entry, sets the response message for use in the view

public
# action_approveEntry( )

deltes a given Entry, sets the response message for use in the view

public
# action_unApproveEntry( )

deltes a given Entry, sets the response message for use in the view

public
# getEntryCount( $cID = NULL )

Properties summary

protected string $btTable
# 'btGuestBook'
protected string $btInterfaceWidth
# "370"
protected string $btInterfaceHeight
# "480"
protected string $btWrapperClass
# 'ccm-ui'
protected array $btExportPageColumns
# array('cID')
protected boolean $btIncludeAll
# true
protected array $btExportTables
# array('btGuestBook', 'btGuestBookEntries')