Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_ipf_About
  • icms_ipf_Handler
  • icms_ipf_Metagen
  • Overview
  • Package
  • Class

Class icms_ipf_Metagen

Generates META tags

Package: Ipf
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Located at ipf/Metagen.php
Methods summary
public
# __construct( string $title, string $keywords = false, string $description = false, string $categoryPath = false )

Constructor for icms_ipf_Metagen

Constructor for icms_ipf_Metagen

Parameters

$title
Page title
$keywords
List of meta keywords
$description
Meta description
$categoryPath
public boolean
# emptyString( $var )

Return true if the string is length > 0

Return true if the string is length > 0

Returns

boolean

Author

psylove

Var

string String to test
public string
# generateSeoTitle( $title = '', $withExt = true )

Create a title for the short_url field of an article

Create a title for the short_url field of an article

Returns

string
sort_url for the article

Author

psylove

Var

string $title title of the article
string $withExt do we add an html extension or not
public string
# html2text( $document )

Parameters

$document

Returns

string
Converted text
public
# setTitle( string $title )

Sets the title property

Sets the title property

Parameters

$title
public
# setKeywords( string $keywords )

Sets the keyword property

Sets the keyword property

Parameters

$keywords
public
# setCategoryPath( string $categoryPath )

Sets the categoryPath property

Sets the categoryPath property

Parameters

$categoryPath
public
# setDescription( string $description )

Sets the description property

Sets the description property

Parameters

$description
public
# createTitleTag( )

An empty function

An empty function

public string
# purifyText( string $text, boolean $keyword = false )

Cleans the provided text, a wrapper for icms_purifyText

Cleans the provided text, a wrapper for icms_purifyText

Parameters

$text
Text to be cleaned
$keyword
Whether the provided string is a keyword, or not

Returns

string
The purified text

See

icms_purifyText
public string
# createMetaDescription( integer $maxWords = 100 )

Creates a meta description

Creates a meta description

Parameters

$maxWords
Maximum number of words for the description

Returns

string
public array
# findMetaKeywords( string $text, integer $minChar )

Generates a list of keywords from the provided text

Generates a list of keywords from the provided text

Parameters

$text
Text to parse
$minChar
Minimum word length for the keywords

Returns

array
An array of keywords
public string
# createMetaKeywords( )

Creates a string of keywords

Creates a string of keywords

Returns

string
public
# autoBuildMeta_keywords( )

An empty function

An empty function

public
# buildAutoMetaTags( )

Generates keywords, description and title, setting the associated properties

Generates keywords, description and title, setting the associated properties

public
# createMetaTags( )

Assigns the meta tags to the template

Assigns the meta tags to the template

Properties summary
public object $_myts
#
public string $_title
#
public string $_original_title
#
public string $_keywords
#
public string $_meta_description
#
public string $_categoryPath
#
public string $_description
#
public integer $_minChar
# 4
API documentation generated by ApiGen