Package DE_EPAGES::SEO::API::SEO
API functions for SEO check on content objects
@EXPORT_OK |
Functions
- AddCategoryDepthSEOCheckValues
- AddCategoryImageSEOCheckValues
- CalculateSEOQuality
- CalculateShopSEOQuality
- CheckForBadSEOHTML
- GetRatingSign
- GetSEOCheckValues
- GetSEOQualityClass
- GetShopSEOQualityValues
- PerformSEOCheck
- PerformSEOCheckAndUpdateObject
- PerformStartPageSEOCheck
- UpdateSEOQuality
AddCategoryDepthSEOCheckValues
Extends hValues with SEO check for the category hierarchy depth.
Syntax |
AddCategoryDepthSEOCheckValues($Object, $Shop, $hValues) |
Input |
|
AddCategoryImageSEOCheckValues
Extends hValues with SEO check for the category image.
Syntax |
AddCategoryImageSEOCheckValues($Object, $Shop, $hValues) |
Input |
|
CalculateSEOQuality
Calculates a rating factor which determindes the SEO quality based on the given values in $hValues.
Syntax |
$Rating = CalculateSEOQuality($hValues, $Object) |
Input |
|
Return |
|
CalculateShopSEOQuality
Calculates a rating factor which determindes the SEO quality for the shop.
Syntax |
$Rating = CalculateShopSEOQuality($hValues) |
Input |
|
Return |
|
CheckForBadSEOHTML
Checks if $Code contains any HTML markup that is horrible for SEO. This for example are title and meta tags, entire new html documents, etc.
Syntax |
$IsOk = CheckForBadSEOHTML($Code) |
Input |
|
Return |
|
GetRatingSign
Returns the html character code for the given SEO rating class string.
Syntax |
$Sign = GetRatingSign($RatingClass) |
Input |
|
Return |
|
GetSEOCheckValues
Calculates various SEO relevant ratings and values for ContentObject SEO checks. Values specific to derived classes can be added/changed unsing a hook.
Syntax |
$hValues = GetSEOCheckValues(Shop, $Object, $LanguageID); |
Input |
|
Return |
|
GetSEOQualityClass
Returns the CSS class string depending on the SEO quality value.
Syntax |
$QualityClass'} = GetSEOQualityClass($Quality); |
Input |
|
Return |
|
GetShopSEOQualityValues
Calculates the SEO quality for the shop. Uses general indicators like domain name, page cache, etc.
Syntax |
$hValues = GetShopSEOQualityValues($Shop) |
Input |
|
Return |
|
PerformSEOCheck
Performs the calculation of the SEO quality.
Syntax |
$hValues = PerformSEOCheck($Object) |
Input |
|
Return |
|
PerformSEOCheckAndUpdateObject
Performs the calculation of the SEO quality. Then calls the UpdateSEOQuality method to update the object.
Syntax |
PerformSEOCheckAndUpdateObject($ContentObject) |
Input |
|
PerformStartPageSEOCheck
Performs the calculation of the SEO quality for the StartPage.
Syntax |
$hValues = PerformStartPageSEOCheck($Object) |
Input |
|
Return |
|
UpdateSEOQuality
Saves the new SEO quality values. See PerformSEOCheck method for details of the $hValues parameter. This method only traverses the per-language data of $hValues and uses the contained 'NewSEOQuality' value to save those quality values.
Syntax |
UpdateSEOQuality($Object, $hValues); |
Example |
my $Object = $Servlet->object; my $hValues = PerformSEOCheck($Object); UpdateSEOQuality($Object, $hValues); |
Input |
|