icms_ipf_Metagen

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_ipf_Metagen

Generates META tags

• Class name: icms_ipf_Metagen
• Namespace:

Properties

$_myts

public \icms_core_Textsanitizer $_myts

Instance of icms_core_Textsanitizer

• Visibility: public

$_title

public string $_title

Title

• Visibility: public

$_original_title

public string $_original_title

Original title

• Visibility: public

$_keywords

public string $_keywords

Keywords

• Visibility: public

$_meta_description

public string $_meta_description

Meta description

• Visibility: public

$_categoryPath

public string $_categoryPath

Category path

• Visibility: public

$_description

public string $_description

Description

• Visibility: public

$_minChar

public int $_minChar = 4

Min chars

• Visibility: public

Methods

__construct

mixed icms_ipf_Metagen::__construct(string title, string keywords, string description, string categoryPath)

Constructor for icms_ipf_Metagen

• Visibility: public

Arguments

• title string - <p>Page title</p>
• keywords string - <p>List of meta keywords</p>
• description string - <p>Meta description</p>
• categoryPath string - <p>Category path</p>

emptyString

bool icms_ipf_Metagen::emptyString(mixed var)

Return true if the string is length > 0

• Visibility: public

Arguments

• var mixed

generateSeoTitle

string icms_ipf_Metagen::generateSeoTitle(mixed title, mixed withExt)

Create a title for the short_url field of an article

• Visibility: public

Arguments

• title mixed
• withExt mixed

html2text

string icms_ipf_Metagen::html2text(document)

• Visibility: public

Arguments

• document mixed

setTitle

mixed icms_ipf_Metagen::setTitle(string title)

Sets the title property

• Visibility: public

Arguments

• title string

setKeywords

mixed icms_ipf_Metagen::setKeywords(string keywords)

Sets the keyword property

• Visibility: public

Arguments

• keywords string

setCategoryPath

mixed icms_ipf_Metagen::setCategoryPath(string categoryPath)

Sets the categoryPath property

• Visibility: public

Arguments

• categoryPath string

setDescription

mixed icms_ipf_Metagen::setDescription(string description)

Sets the description property

• Visibility: public

Arguments

• description string

createTitleTag

mixed icms_ipf_Metagen::createTitleTag()

An empty function

• Visibility: public

purifyText

string icms_ipf_Metagen::purifyText(string text, bool keyword)

Cleans the provided text, a wrapper for icms_purifyText

• Visibility: public

Arguments

• text string - <p>Text to be cleaned</p>
• keyword bool - <p>Whether the provided string is a keyword, or not</p>

createMetaDescription

string icms_ipf_Metagen::createMetaDescription(int maxWords)

Creates a meta description

• Visibility: public

Arguments

• maxWords int - <p>Maximum number of words for the description</p>

findMetaKeywords

array icms_ipf_Metagen::findMetaKeywords(\steing text, int minChar)

Generates a list of keywords from the provided text

• Visibility: public

Arguments

• text steing - <p>Text to parse</p>
• minChar int - <p>Minimum word length for the keywords</p>

createMetaKeywords

string icms_ipf_Metagen::createMetaKeywords()

Creates a string of keywords

• Visibility: public

autoBuildMeta_keywords

mixed icms_ipf_Metagen::autoBuildMeta_keywords()

An empty function

• Visibility: public

buildAutoMetaTags

mixed icms_ipf_Metagen::buildAutoMetaTags()

Generates keywords, description and title, setting the associated properties

• Visibility: public

createMetaTags

mixed icms_ipf_Metagen::createMetaTags()

Assigns the meta tags to the template

• Visibility: public