OXID eShop CE  4.9.7
 All Classes Files Functions Variables Pages
oxTag Class Reference
+ Inheritance diagram for oxTag:
+ Collaboration diagram for oxTag:

Public Member Functions

 __construct ($sTag=null)
 setMaxLength ($iTagMaxLength)
 getMaxLength ()
 set ($sTag, $blPrepare=true)
 get ()
 setHitCount ($iHitCount)
 getHitCount ()
 increaseHitCount ()
 isValid ()
 getLink ()
 setLink ($sTagLink=null)
 getTitle ()
 __toString ()
 prepare ($sTag)
 stripMetaChars ($sText)
 formLink ($sTag)
 addUnderscores ()
 removeUnderscores ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Attributes

 $_sTag = ''
 $_aForbiddenTags
 $_sTagLink = null
 $_iTagMaxLength = 60
 $_iHitCount = 1
 $_aMetaChars = array('+', '-', '>', '<', '(', ')', '~', '*', '"', '\'', '\\', '[', ']', '{', '}', ';', ':', '.', '/', '|', '!', '@', '#', '$', '%', '^', '&', '?', '=', '`')

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

Class dedicated to tags handling

Definition at line 10 of file oxtag.php.

Constructor & Destructor Documentation

oxTag::__construct (   $sTag = null)

Sets tag value

Parameters
string$sTagtag value

Definition at line 62 of file oxtag.php.

Member Function Documentation

oxTag::__toString ( )

Renders tag

Returns
string

Definition at line 194 of file oxtag.php.

oxTag::addUnderscores ( )

Adds dashes to too short tag words, so that they would be equal to minTagLength

Definition at line 263 of file oxtag.php.

oxTag::formLink (   $sTag)

Returns tag url (seo or dynamic depends on shop mode)

Parameters
string$sTagtag
Returns
string

Definition at line 246 of file oxtag.php.

oxTag::get ( )

Sets tag value

Returns
string Tag value

Definition at line 107 of file oxtag.php.

oxTag::getHitCount ( )

Returns tag size value

Returns
int Tag size value

Definition at line 127 of file oxtag.php.

oxTag::getLink ( )

Returns tag url (seo or dynamic depends on shop mode)

Returns
string

Definition at line 160 of file oxtag.php.

oxTag::getMaxLength ( )

Returns maximum tag length

Returns
int

Definition at line 85 of file oxtag.php.

oxTag::getTitle ( )

Returns html safe tag title

Returns
string

Definition at line 184 of file oxtag.php.

oxTag::increaseHitCount ( )

Increases tag size value

Definition at line 135 of file oxtag.php.

oxTag::isValid ( )

Checks if tag is valid

Returns
bool

Definition at line 145 of file oxtag.php.

oxTag::prepare (   $sTag)

Takes tag string, checks its length and makes longer tag shorter if needed. Also trims it and removes unnecessary characters.

Parameters
string$sTagtag value
Returns
object oxTag

Definition at line 207 of file oxtag.php.

oxTag::removeUnderscores ( )

Removes dashes from tag words.

Definition at line 280 of file oxtag.php.

oxTag::set (   $sTag,
  $blPrepare = true 
)

Sets tag value

Parameters
string$sTagTag value
bool$blPrepareif false, no checks will be done when setting

Definition at line 96 of file oxtag.php.

oxTag::setHitCount (   $iHitCount)

Sets tag size value

Parameters
int$iHitCountsize of tag

Definition at line 117 of file oxtag.php.

oxTag::setLink (   $sTagLink = null)

Sets tag url. If nothing is passed, link is reset to null

Parameters
string$sTagLinkformed tag link

Definition at line 174 of file oxtag.php.

oxTag::setMaxLength (   $iTagMaxLength)

Sets maximum tag length

Parameters
int$iTagMaxLengthTag maximum length

Definition at line 75 of file oxtag.php.

oxTag::stripMetaChars (   $sText)

Changes any mysql specific meta characters with spaces

Parameters
string$sTextgiven text
Returns
string

Definition at line 226 of file oxtag.php.

Member Data Documentation

oxTag::$_aForbiddenTags
protected
Initial value:
array(
'admin', 'application', 'core', 'export', 'modules', 'out', 'setup', 'tmp'
)

Forbidden tags

Definition at line 23 of file oxtag.php.

oxTag::$_aMetaChars = array('+', '-', '>', '<', '(', ')', '~', '*', '"', '\'', '\\', '[', ']', '{', '}', ';', ':', '.', '/', '|', '!', '@', '#', '$', '%', '^', '&', '?', '=', '`')
protected

Definition at line 55 of file oxtag.php.

oxTag::$_iHitCount = 1
protected

Definition at line 47 of file oxtag.php.

oxTag::$_iTagMaxLength = 60
protected

Definition at line 40 of file oxtag.php.

oxTag::$_sTag = ''
protected

Definition at line 18 of file oxtag.php.

oxTag::$_sTagLink = null
protected

Definition at line 32 of file oxtag.php.


The documentation for this class was generated from the following file: