Tags class - Documentation for SproutCMS

Info Page:

Page options:

class Tags

No description yet.

File: /sprout/Helpers/Tags.php
Namespace: Sprout\Helpers

Functions

Name	Visibility	Description
beginsWith	public (static)	Returns all tags which begin with a given string
byRecord	public (static)	Returns all of the tags for a given record
byTable	public (static)	Returns all of the tags for a given table
findRecords	public (static)	Returns all of the records for a given table/tag
getList	public (static)	Get HTML for a tag list (i.e. for tag display on the front-end)
recordCounts	public (static)	Return the tags for a table, along with the number of records for each tag
recordCountsPerSubsite	public (static)	Return the tags for a table, along with the number of records for each tag
splitupTags	public (static)	Converts a comma-separated string into a list of tags
suggestTags	public (static)	Returns common tags. Typically tags are returned from the provided table, but not necessarily.
update	public (static)	Updates tags for a given record

public beginsWith

array Tags::beginsWith ( string $prefix );

Returns all tags which begin with a given string

public byRecord

array Tags::byRecord ( string $table , int $record_id );

Returns all of the tags for a given record

public byTable

array Tags::byTable ( string $table );

Returns all of the tags for a given table

public findRecords

array Tags::findRecords ( string $table , string $tag );

Returns all of the records for a given table/tag

public getList

string Tags::getList ( [ array $tags ] );

Get HTML for a tag list (i.e. for tag display on the front-end)

public recordCounts

array Tags::recordCounts ( string $table , int $limit );

Return the tags for a table, along with the number of records for each tag

public recordCountsPerSubsite

array Tags::recordCountsPerSubsite ( string $table , int $limit [, int $subsite_id ] );

Return the tags for a table, along with the number of records for each tag
Results are filtered by subsite, including records with subsite_id of NULL which is all sites

public splitupTags

array Tags::splitupTags ( string $string );

Converts a comma-separated string into a list of tags

public suggestTags

array Tags::suggestTags ( [ string $table [, string $prefix [, int $number ]]] );

Returns common tags. Typically tags are returned from the provided table, but not necessarily.

public update

bool Tags::update ( string $table , int $record_id , array $new_tags [, bool $remove ] );

Updates tags for a given record

SproutCMS

Search documentation