Docs For Class CMS_block

Description

Class CMS_block_link

represent a block of link data inside a row.

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/modules/standard/blocklink.php (line 25)

CMS_grandFather
   |
   --CMS_block
      |
      --CMS_block_link

Class Constant Summary

MESSAGE_BLOCK_LINK_LABEL = 147

Method Summary

boolean delFromLocation (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, [boolean $public = false], [boolean $withfile = false])

CMS_block duplicate ( &$destinationPage, [boolean $public = false], CMS_page $destinationPage,)

string getData (CMS_language &$language, CMS_page &$page, CMS_clientSpace &$clientSpace, CMS_row &$row, integer $visualizationMode)

array(mixed=>mixed) getRawData (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, boolean $public)

CMS_block_link __construct ([ $id = 0], [integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false], integer $id,)

boolean writeToPersistence (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, boolean $public, array(mixed=>mixed) $data)

string _getDataTableName (integer $location, boolean $public)

string _getHTMLForm ( $language, CMS_page &$page, CMS_clientSpace &$clientSpace, CMS_row &$row, integer $blockID, string $data, CMS_language &$language)

string _replaceBlockVars (array $link, array $attributes, integer $location, boolean $public)

Methods

delFromLocation (line 284)

Deletes the block from a location (public, archived, deleted, edited)

return: true on success, false on failure
access: public

boolean delFromLocation (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, [boolean $public = false], [boolean $withfile = false])

integer $pageID: The page which contains the client space, DB ID
integer $clientSpaceID: The client space which contains the row, DB ID
integer $rowID: The row which contains the block, DB ID
integer $location: The location we want to completly remove the block from
boolean $public: The precision needed for USERSPACE location
boolean $withfile: : delete the attached file if any (default : false)

Redefinition of:

CMS_block::delFromLocation(): Deletes the block from a location (public, archived, deleted, edited)

duplicate (line 393)

Duplicate this block Used to duplicate a CMS_page.

return: object

CMS_block duplicate ( &$destinationPage, [boolean $public = false], CMS_page $destinationPage,)

CMS_page $destinationPage,: the page receiving a copy of this block
boolean $public: The precision needed for USERSPACE location
&$destinationPage

Redefinition of:

CMS_block::duplicate(): Duplicate this block, all datas rebnamed and saved Used to duplicate a CMS_page.

getData (line 87)

Gets the data in HTML mode.

return: the HTML data
access: public

string getData (CMS_language &$language, CMS_page &$page, CMS_clientSpace &$clientSpace, CMS_row &$row, integer $visualizationMode)

CMS_language &$language: The language of the administration frontend
CMS_page &$page: The page which contains the client space
CMS_clientSpace &$clientSpace: The client space which contains the row
CMS_row &$row: The row which contains the block
integer $visualizationMode: The visualization mode used

Redefinition of:

CMS_block::getData(): Gets the data in HTML mode.

getRawData (line 213)

Gets the data in array mode.

return: The data indexed by data type (value, file, alt_tag, ...), or false on failure (table not found)
access: public

array(mixed=>mixed) getRawData (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, boolean $public)

integer $pageID: The page DB ID which contains the client space
integer $clientSpaceID: The client space DB ID which contains the row
integer $rowID: The row DB ID which contains the block
integer $location: The location of the page
boolean $public: The needed precision for USERSPACE location

Redefinition of:

CMS_block::getRawData(): Gets the data in array mode.

Constructor __construct (line 46)

Constructor Used while getting all datas from database Useful for duplicate function for example

access: public

CMS_block_link __construct ([ $id = 0], [integer $location = RESOURCE_LOCATION_USERSPACE], [boolean $public = false], integer $id,)

integer $id,: DB ID of this block
integer $location: The location we want to get the block from
boolean $public: The needed precision for USERSPACE location
$id

writeToPersistence (line 327)

Writes the block data into persistence (destroys previous and insert new)

return: true on success, false on failure
access: public

boolean writeToPersistence (integer $pageID, integer $clientSpaceID, integer $rowID, integer $location, boolean $public, array(mixed=>mixed) $data)

integer $pageID: The page which contains the client space, DB ID
integer $clientSpaceID: The client space which contains the row, DB ID
integer $rowID: The row which contains the block, DB ID
integer $location: The location we want to completly remove the block from
boolean $public: The precision needed for USERSPACE location
array(mixed=>mixed) $data: The data indexed by data type (value, file, alt_tag, ...),

Redefinition of:

CMS_block::writeToPersistence(): Writes the block data into persistence (destroys previous and insert new)

_getDataTableName (line 253)

Gets the table name which depends of the page location

return: The table name
access: public

string _getDataTableName (integer $location, boolean $public)

integer $location: The location we want to completly remove the block from
boolean $public: The precision needed for USERSPACE location

_getHTMLForm (line 369)

Get the HTML form given the block HTML example data.

return: The HTML form which can send to the page that will modify the block
access: private

string _getHTMLForm ( $language, CMS_page &$page, CMS_clientSpace &$clientSpace, CMS_row &$row, integer $blockID, string $data, CMS_language &$language)

CMS_language &$language: The language of the administration frontend
CMS_page &$page: The page which contains the client space
CMS_clientSpace &$clientSpace: The client space which contains the row
CMS_row &$row: The row which contains the block
integer $blockID: The tag ID of the block
string $data: The data to show as example
$language

Redefinition of:

CMS_block::_getHTMLForm(): Get the HTML form given the block HTML example data.

_replaceBlockVars (line 192)

Replace block definition vars.

return: the HTML data
access: public

string _replaceBlockVars (array $link, array $attributes, integer $location, boolean $public)

integer $location: The location of the page
boolean $public: The needed precision for USERSPACE location
array $link: link : the block datas (CMS_href)
array $attributes: attributes : html attributes to add

Inherited Methods

Inherited From CMS_block

CMS_block::CMS_block()
CMS_block::changeClientSpace()
CMS_block::delFromLocation()
CMS_block::duplicate()
CMS_block::getAttribute()
CMS_block::getData()
CMS_block::getRawData()
CMS_block::initializeFromBasicAttributes()
CMS_block::initializeFromID()
CMS_block::initializeFromTag()
CMS_block::writeToPersistence()
CMS_block::_getFolderName()
CMS_block::_getHTMLForm()

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

MESSAGE_BLOCK_LINK_LABEL = 147 (line 27)

Inherited Constants

Inherited from CMS_block

CMS_block::MESSAGE_BLOCK_CONTENT_ERROR

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL