LinkSpecDocument class - Documentation for SproutCMS

Info Page:

Page options:

class LinkSpecDocument

File: /sprout/Helpers/LinkSpecDocument.php
Namespace: Sprout\Helpers
Extends: LinkSpec

Functions

Name	Visibility	Description
getAttrs	public	Get any extra html attributes to use for a given link
getEditForm	public	Get the HTML to use for editing a given linkspec
getUrl	public	Get the URL for a given link
isValid	public	Validate the submission, for instances where certain constraints apply
loadNeeds	public	If there are any Needs calls that the edit form requires, they should be loaded here

public getAttrs

array $LinkSpecDocument->getAttrs ( mixed $specdata );

Get any extra html attributes to use for a given link

public getEditForm

unknown $LinkSpecDocument->getEditForm ( mixed $field_name , mixed $curr_specdata );

Get the HTML to use for editing a given linkspec

The HTML should create a HTML field with the name $field_name
If there is a spec currently being edited, the specdata will
be provided in $curr_specdata

public getUrl

unknown $LinkSpecDocument->getUrl ( mixed $specdata );

Get the URL for a given link

public isValid

unknown $LinkSpecDocument->isValid ( mixed $specdata );

Validate the submission, for instances where certain constraints apply

public loadNeeds

void $LinkSpecDocument->loadNeeds ( );

If there are any Needs calls that the edit form requires, they should be loaded here

SproutCMS