REDAXO 5
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • redaxo
    • backup
    • be-style
    • core
      • backend
      • form
      • login
      • minibar
      • packages
      • sql
    • cronjob
      • article-status
      • optimize-tables
    • media-manager
    • mediapool
    • metainfo
    • phpmailer
    • structure
      • content
        • minibar
      • history
      • version
    • users

Classes

  • rex_api_article_move
  • rex_api_content_copy
  • rex_api_sitemap_tree
  • rex_article
  • rex_article_cache
  • rex_article_service
  • rex_category
  • rex_category_select
  • rex_category_service
  • rex_form_widget_linklist_element
  • rex_form_widget_linkmap_element
  • rex_navigation
  • rex_structure_element
  • rex_structure_perm
  • rex_var_article
  • rex_var_category
  • rex_var_link
  • rex_var_linklist

Functions

  • rex_getUrl
  • rex_redirect

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.

Constructor.

Parameters

$params
public string
# getValue( string $value )

Returns Object Value.

Returns Object Value.

Parameters

$value

Returns

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

Parameters

$value
$prefixes

Returns

boolean
bool
public static string[]
# getClassVars( )

Returns an Array containing article field names.

Returns an Array containing article field names.

Returns

string[]
string[]
public static
# resetClassVars( )
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.

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.

Parameters

$id
the article id
$clang
the clang id

Returns

static|null
A rex_structure_element instance typed to the late-static binding type of the caller
protected static static[]
# getChildElements( integer $parentId, string $listType, boolean $ignoreOfflines = false, integer $clang = null )

Parameters

$parentId
$listType
$ignoreOfflines
$clang

Returns

static[]
static[]
public integer
# getClang( )

Returns the clang of the category.

Returns the clang of the category.

Deprecated

since redaxo 5.6, use getClangId() instead

Returns

integer
int
public integer
# getClangId( )

Returns the clang of the category.

Returns the clang of the category.

Returns

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

Returns a url for linking to this article.

Returns a url for linking to this article.

Parameters

$params
$divider

Returns

string
string
public integer
# getId( )

Returns the id of the article.

Returns the id of the article.

Returns

integer
int
public integer
# getParentId( )

Returns the parent_id of the article.

Returns the parent_id of the article.

Returns

integer
int
abstract public string
# getPath( )

Returns the path of the category/article.

Returns the path of the category/article.

Returns

string
string
public int[]
# getPathAsArray( )

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

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

Returns

int[]
int[]
abstract public self
# getParent( )

Returns the parent category.

Returns the parent category.

Returns

self
self
public string
# getName( )

Returns the name of the article.

Returns the name of the article.

Returns

string
string
public integer
# getPriority( )

Returns the article priority.

Returns the article priority.

Returns

integer
int
public string
# getUpdateUser( )

Returns the last update user.

Returns the last update user.

Returns

string
string
public integer
# getUpdateDate( )

Returns the last update date.

Returns the last update date.

Returns

integer
int
public string
# getCreateUser( )

Returns the creator.

Returns the creator.

Returns

string
string
public integer
# getCreateDate( )

Returns the creation date.

Returns the creation date.

Returns

integer
int
public boolean
# isOnline( )

Returns true if article is online.

Returns true if article is online.

Returns

boolean
bool
public integer
# getTemplateId( )

Returns the template id.

Returns the template id.

Returns

integer
int
public boolean
# hasTemplate( )

Returns true if article has a template.

Returns true if article has a template.

Returns

boolean
bool
abstract public boolean
# isPermitted( )

Returns whether the element is permitted.

Returns whether the element is permitted.

Returns

boolean
bool
public string
# toLink( array $params = [], array $attributes = [], string $sorroundTag = null, array $sorroundAttributes = [] )

Returns a link to this article.

Returns a link to this article.

Parameters

$params
Parameter für den Link
$attributes
Attribute die dem Link hinzugefügt werden sollen. Default: array
$sorroundTag
HTML-Tag-Name mit dem der Link umgeben werden soll, z.b. 'li', 'div'. Default: null
$sorroundAttributes
Attribute die Umgebenden-Element hinzugefügt werden sollen. Default: array

Returns

string
string
protected string
# _toAttributeString( array $attributes )

Parameters

$attributes

Returns

string
string
public rex_category[]
# getParentTree( )

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

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

Returns

rex_category[]
rex_category[]
public boolean
# inParentTree( rex_structure_element $anObj )

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

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

Parameters

$anObj

Returns

boolean
bool
public boolean
# isStartArticle( )

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

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

Returns

boolean
bool
public boolean
# isSiteStartArticle( )

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

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

Returns

boolean
bool
public boolean
# isNotFoundArticle( )

Returns true if this Article is the not found article.

Returns true if this Article is the not found article.

Returns

boolean
bool

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
#
REDAXO 5 API documentation generated by ApiGen 3.0dev