kernel/private/api/content/location.php
Show:
inherited
inherited
Classes
File containing the ezpContentLocation class
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- API
- Version
- 4.6.0
\ezpContentLocation
Package: API
This class is used to manipulate a specific content location.
It currently acts among others as a wrapper around eZContentObjectTreeNode, and therefore exposes some of
- Parent(s)
- \ezpLocation
Properties
\node_id
= ''
eZContentObjectTreeNode
eZContentObjectTreeNode
Details
- Type
- \node_id
- Magic
- Property
- eZContentObjectTreeNode
$node= ''
Details
- Type
- n/a
$validNodeAttributes= 'array( 'node_id', 'path_string', 'name', 'url_alias', 'is_main', 'remote_id' )'
static
Default value
array( 'node_id', 'path_string', 'name', 'url_alias', 'is_main', 'remote_id' )Details- Type
- n/a
Methods
__get(
$property
)
:
voidWrapper for node attributes
Parameters
| Name | Type | Description |
|---|---|---|
| $property |
fetchByNodeId(
int $nodeId
)
:
\ezpContentLocation
static
Returns the ezpContentLocation object for a particular node by ID
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $nodeId | int |
| Type | Description |
|---|---|
| \ezpContentLocation |
| Exception | Description |
|---|---|
| \ezcBaseException | When the node is not found |
fromNode(
\eZContentObjectTreeNode $node
)
:
\ezpContentLocation
static
Returns the ezpContentLocation object for a particular node object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $node | \eZContentObjectTreeNode |
| Type | Description |
|---|---|
| \ezpContentLocation |