SilverStripe Link

Link extends DataObject

in package

• silverstripe
• silverstripe
• link

Link

Tags

subpackage

silverstripe-link

mixin

LinkSiteTree

Table of Contents

Properties

$classes  : string

$template_style  : string

$allowed_types  : array<string|int, mixed>

List the allowed included link types. If null all are allowed.

$casting  : array<string|int, mixed>

Ensures that the methods are wrapped in the correct type and values are safely escaped while rendering in the template.

$db  : array<string|int, mixed>

Database fields

$gql_fields  : mixed

Provides a quick way to define additional methods for provideGraphQLScaffolding as Fields

$gql_nested_queries  : array<string|int, mixed>

Provides a quick way to define additional methods for provideGraphQLScaffolding as Nested Queries

$has_one  : array<string|int, mixed>

Has_one relationship

$link_to_folders  : bool

If false, when Type is "File", folders in the TreeDropdownField will not be selectable.

$linking_mode_current  : string

$linking_mode_default  : string

$linking_mode_section  : string

$owns  : mixed

$searchable_fields  : array<string|int, mixed>

Defines a default list of filters for the search context

$styles  : array<string|int, mixed>

A map of styles that are available in the cms for users to select from.

$summary_fields  : array<string|int, mixed>

Defines summary fields commonly used in table columns as a quick overview of the data for this dataobject

$table_name  : string

Defines the database table name

$types  : array<string|int, mixed>

A map of object types that can be linked to Custom dataobjects can be added to this

Methods

addExtraClass()  : Link

Set CSS classes for templates

baseClassName()  : string

Returns the base class without namespacing

canCreate()  : bool

canDelete()  : bool

canEdit()  : bool

canView()  : bool

File()  : File

forTemplate()  : DBHTMLText

Renders an HTML anchor attribute for this link

getClass()  : string

Returns the css classes

getClassAttr()  : HTMLFragment

Returns the html class attribute

getCMSFields()  : FieldList

CMS Fields

getCMSMainFields()  : array<string|int, mixed>

CMS Main fields This is so other modules can access these fields without other tabs etc.

getCurrentPage()  : Controller

Returns the current page scope

geti18nStyles()  : array<string|int, mixed>

Returns available styles with translations

geti18nTypes()  : array<string|int, mixed>

Returns allowed link types with translations

getIDAttr()  : HTMLFragment

Renders an HTML ID attribute

getIDValue()  : string

Returns the html id attribute

getLayout()  : string

Renders an HTML anchor tag for this link This is an alias to {@link forTemplate()}

getLinkURL()  : string

Works out what the URL for this link should be based on it's Type

getRenderTemplates()  : array<string|int, mixed>

Returns a list of rendering templates

getStyle()  : Link

Get style defined by the template or admin

getStyles()  : array<string|int, mixed>

Returns available styles

getTarget()  : string

Returns the html target attribute

getTargetAttr()  : HTMLFragment

Returns the html target attribute

getTypeLabel()  : string

Returns the description label of this links type

getTypes()  : array<string|int, mixed>

Returns allowed link types

gqlFields()  : array<string|int, mixed>

Provides a quick way to define additional methods to provideGraphQLScaffolding as Fields

gqlNestedQueries()  : array<string|int, mixed>

Provides a quick way to define additional methods to provideGraphQLScaffolding as Nested Queries

isCurrent()  : bool

Returns true if this is the currently active page being used to handle this request.

isOrphaned()  : bool

Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible to external users.

isSection()  : bool

Check if this page is in the currently active section (e.g. it is either current or one of its children is currently being viewed).

LinkingMode()  : string

Return "link", "current" or "section" depending on if this page is the current page, or not on the current page but in the current section.

LinkOrCurrent()  : string

Return "link" or "current" depending on if this is the {@link Link::isCurrent()} current page.

LinkOrSection()  : string

Return "link" or "section" depending on if this is the {@link Link::isSection()} current section.

onBeforeWrite()  : mixed

Event handler called before writing to the database.

setAllowedTypes()  : Link

Sets allowed link types

setClass()  : Link

This is an alias to {@link addExtraClass()}

setStyle()  : Link

Set style used for

validate()  : ValidationResult

Validate