eZSection Class Reference

eZSection handles grouping of content in eZ Publish More...

Inheritance diagram for eZSection:

Collaboration diagram for eZSection:

List of all members.

Public Member Functions
	canBeRemoved ($sectionID=false)
	eZSection ($row)
	removeThis ($conditions=null, $extraConditions=null)
Static Public Member Functions
static	definition ()
static	fetch ($sectionID, $asObject=true)
static	fetchByIdentifier ($sectionIdentifier, $asObject=true)
	fetch object by section identifier
static	fetchByOffset ($offset, $limit, $asObject=true)
static	fetchFilteredList ($conditions=null, $offset=false, $limit=false, $asObject=true)
static	fetchList ($asObject=true)
static	globalID ()
	Return the global section ID or null if it is not set yet.
static	initGlobalID ()
	Makes sure the global section ID is propagated to the template override key.
static	sectionCount ()
static	setGlobalID ($sectionID)
	Sets the current global section ID to $sectionID in the session and the template override key.

---

Detailed Description

eZSection handles grouping of content in eZ Publish

Definition at line 17 of file ezsection.php.

---

Member Function Documentation

eZSection::canBeRemoved

(

$

sectionID = false

)

Definition at line 218 of file ezsection.php.

static eZSection::definition

(

)

[static]

Returns:

the persistent object definition for the eZSection class.

Reimplemented from eZPersistentObject.

Definition at line 31 of file ezsection.php.

Referenced by fetch(), fetchByIdentifier(), fetchByOffset(), fetchFilteredList(), and fetchList().

eZSection::eZSection

(

$

row

)

Definition at line 19 of file ezsection.php.

static eZSection::fetch	(	$	sectionID,
		$	asObject = true
	)		[static]

Returns:

the section object with the given id.

Definition at line 64 of file ezsection.php.

Referenced by checkRelationActions(), eZSectionFunctionCollection\fetchSectionObject(), eZNodeviewfunctions\generateNodeViewData(), and sectionEditActionCheck().

static eZSection::fetchByIdentifier	(	$	sectionIdentifier,
		$	asObject = true
	)		[static]

fetch object by section identifier

Parameters:

string	$sectionIdentifier
boolean	$asObject

Returns:

object|null

Definition at line 94 of file ezsection.php.

Referenced by eZSectionFunctionCollection\fetchSectionObject().

static eZSection::fetchByOffset	(	$	offset,
		$	limit,
		$	asObject = true
	)		[static]

Definition at line 146 of file ezsection.php.

static eZSection::fetchFilteredList	(	$	conditions = null,
		$	offset = false,
		$	limit = false,
		$	asObject = true
	)		[static]

Definition at line 127 of file ezsection.php.

Referenced by eZSiteInstaller\sectionIDbyName().

static eZSection::fetchList

(

$

asObject = true

)

[static]

Definition at line 139 of file ezsection.php.

Referenced by eZMultiplexerType\attribute(), eZApproveType\attribute(), eZSectionFunctionCollection\fetchSectionList(), and eZContentFunctionCollection\fetchSectionList().

static eZSection::globalID

(

)

[static]

Return the global section ID or null if it is not set yet.

Deprecated:

since 4.4, global section support has been removed and null is always returned.

Returns:

null

Definition at line 200 of file ezsection.php.

static eZSection::initGlobalID

(

)

[static]

Makes sure the global section ID is propagated to the template override key.

Deprecated:

since 4.4, global section support has been removed

Returns:

false

Definition at line 174 of file ezsection.php.

eZSection::removeThis	(	$	conditions = null,
		$	extraConditions = null
	)

Will remove the current section from the database.

Note:

Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 210 of file ezsection.php.

static eZSection::sectionCount

(

)

[static]

Returns:

the number of active orders

Definition at line 160 of file ezsection.php.

static eZSection::setGlobalID

(

$

sectionID

)

[static]

Sets the current global section ID to $sectionID in the session and the template override key.

Deprecated:

since 4.4, global section support has been removed this function only sets value to override values for bc.

Parameters:

int

$sectionID

Definition at line 187 of file ezsection.php.

---

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

• ezsection.php