Class rex_structure_element

Object Oriented Framework: Basisklasse für die Strukturkomponenten.

rex_structure_element uses rex_instance_pool_trait, rex_instance_list_pool_trait

Direct known subclasses

rex_article, rex_category

Abstract
Package: redaxo\structure
Located at redaxo/src/addons/structure/lib/structure_element.php

Methods summary

protected
# __construct( array $params )

Constructor.

public string
# getValue( string $value )

Returns Object Value.

protected static boolean
# _hasValue( string $value, array $prefixes = [] )
public static string[]
# getClassVars( )

Returns an Array containing article field names.

public static
public static static|null
# get( integer $id, integer $clang = null )

Return an rex_structure_element object based on an id. The instance will be cached in an instance-pool and therefore re-used by a later call.

protected static static[]
# getChildElements( integer $parentId, string $listType, boolean $ignoreOfflines = false, integer $clang = null )
public integer
# getClang( )

Returns the clang of the category.

public integer
# getClangId( )

Returns the clang of the category.

public string
# getUrl( array $params = [], string $divider = '&' )

Returns a url for linking to this article.

public integer
# getId( )

Returns the id of the article.

public integer
# getParentId( )

Returns the parent_id of the article.

abstract public string
# getPath( )

Returns the path of the category/article.

public int[]
# getPathAsArray( )

Returns the path ids of the category/article as an array.

abstract public self
# getParent( )

Returns the parent category.

public string
# getName( )

Returns the name of the article.

public integer
# getPriority( )

Returns the article priority.

public string
# getUpdateUser( )

Returns the last update user.

public integer
# getUpdateDate( )

Returns the last update date.

public string
# getCreateUser( )

Returns the creator.

public integer
# getCreateDate( )

Returns the creation date.

public boolean
# isOnline( )

Returns true if article is online.

public integer
# getTemplateId( )

Returns the template id.

public boolean
# hasTemplate( )

Returns true if article has a template.

abstract public boolean
# isPermitted( )

Returns whether the element is permitted.

protected string
# _toAttributeString( array $attributes )
public rex_category[]
# getParentTree( )

Get an array of all parentCategories. Returns an array of rex_structure_element objects.

public boolean
# inParentTree( rex_structure_element $anObj )

Checks if $anObj is in the parent tree of the object.

public boolean
# isStartArticle( )

Returns true if this Article is the Startpage for the category.

public boolean
# isSiteStartArticle( )

Returns true if this Article is the Startpage for the entire site.

public boolean
# isNotFoundArticle( )

Returns true if this Article is the not found article.

Methods used from rex_instance_pool_trait

addInstance(), clearInstance(), clearInstancePool(), getInstance(), hasInstance()

Methods used from rex_instance_list_pool_trait

addInstanceList(), clearInstanceList(), clearInstanceListPool(), getInstanceList(), hasInstanceList()

Properties summary

protected string $id
#''
protected string $parent_id
#''
protected string $clang_id
#''
protected string $name
#''
protected string $catname
#''
protected string $template_id
#''
protected string $path
#''
protected string $priority
#''
protected string $catpriority
#''
protected string $startarticle
#''
protected string $status
#''
protected string $updatedate
#''
protected string $createdate
#''
protected string $updateuser
#''
protected string $createuser
#''
protected static mixed $classVars