Inheritance diagram for OxidEsales\EshopCommunity\Core\SeoEncoder:

Collaboration diagram for OxidEsales\EshopCommunity\Core\SeoEncoder:

Public Member Functions
	addLanguageParam ($sSeoUrl, $iLang)

	__construct ()

	getDynamicObjectId ($iShopId, $sStdUrl)

	encodeString ($sString, $blReplaceChars=true, $iLang=false)

	setSeparator ($sSeparator=null)

	setPrefix ($sPrefix)

	setIdLength ($iIdlength=null)

	setReservedWords ($aReservedWords)

	markAsExpired ($sId, $iShopId=null, $iExpStat=1, $iLang=null, $sParams=null)

	encodeStaticUrls ($aStaticUrl, $iShopId, $iLang)

	copyStaticUrls ($iShopId)

	getStaticUrl ($sStdUrl, $iLang=null, $iShopId=null)

	addSeoEntry ($sObjectId, $iShopId, $iLang, $sStdUrl, $sSeoUrl, $sType, $blFixed=1, $sKeywords='', $sDescription='', $sParams='', $blExclude=false, $sAltObjectId=null)

	deleteSeoEntry ($objectId, $shopId, $language, $type)

	getMetaData ($sObjectId, $sMetaType, $iShopId=null, $iLang=null)

	getDynamicUrl ($sStdUrl, $sSeoUrl, $iLang)

	fetchSeoUrl ($standardUrl, $languageId=null)

Protected Member Functions
	_processSeoUrl ($sSeoUrl, $sObjectId=null, $iLang=null, $blExclude=false)

	_copyToHistory ($sId, $iShopId, $iLang, $sType=null, $sNewId=null)

	_getDynamicUri ($sStdUrl, $sSeoUrl, $iLang)

	_getFullUrl ($sSeoUrl, $iLang=null, $blSsl=false)

	_getSeoIdent ($sSeoUrl)

	_getStaticUri ($sStdUrl, $iShopId, $iLang)

	_getUrlExtension ()

	_getUniqueSeoUrl ($sSeoUrl, $sObjectId=null, $iObjectLang=null)

	_isFixed ($sType, $sId, $iLang, $iShopId=null, $sParams=null, $blStrictParamsCheck=true)

	_getCacheKey ($sType, $iLang=null, $iShopId=null, $sParams=null)

	_loadFromCache ($sCacheIdent, $sType, $iLang=null, $iShopId=null, $sParams=null)

	_saveInCache ($sCacheIdent, $sCache, $sType, $iLang=null, $iShopId=null, $sParams=null)

	_loadFromDb ($sType, $sId, $iLang, $iShopId=null, $sParams=null, $blStrictParamsCheck=true)

	_getReservedEntryKeys ()

	_prepareUri ($sUri, $iLang=false)

	_prepareTitle ($sTitle, $blSkipTruncate=false, $iLang=false)

	_saveToDb ($sType, $sObjectId, $sStdUrl, $sSeoUrl, $iLang, $iShopId=null, $blFixed=null, $sParams=null)

	executeQuery ($query)

	_trimUrl ($sUrl, $iLang=null)

	_getMaxUrlLength ()

	_getPageUri ($oObject, $sType, $sStdUrl, $sSeoUrl, $sParams, $iLang=null, $blFixed=false)

	_getStaticObjectId ($iShopId, $sStdUrl)

	_getAltUri ($sObjectId, $iLang)

	executeDatabaseQuery ($query)

	replaceSpecialChars ($stringWithSpecialChars)

	assembleFullPageUrl ($object, $type, $stdUrl, $seoUrl, $pageNumber, $parameters, $languageId, $isFixed)

Protected Attributes
	$_iIdLength = 255

	$_sAddParams = null

	$_iMaxUrlLength = null

Static Protected Attributes
static	$_aReservedWords = ['admin']

static	$_aReservedEntryKeys = null

static	$_sSeparator = null

static	$_sPrefix = null

static	$_aFixedCache = []

static	$_sCacheKey = null

static	$_aCache = []

Detailed Description

Seo encoder base

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\SeoEncoder::__construct ( )

SEO encoder constructor

Member Function Documentation

◆ _copyToHistory()

OxidEsales\EshopCommunity\Core\SeoEncoder::_copyToHistory	(	$sId,
		$iShopId,
		$iLang,
		$sType = `null`,
		$sNewId = `null`
	)

protected

Moves current seo record to seo history table

Parameters

string	$sId	object id
int	$iShopId	active shop id
int	$iLang	object language
string	$sType	object type (if you pass real object - type is not necessary)
string	$sNewId	new object id, mostly used for static url updates (optional)

◆ _getAltUri()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getAltUri	(	$sObjectId,
		$iLang
	)

protected

Returns alternative uri used while updating seo

Parameters

string	$sObjectId	object id
int	$iLang	language id

◆ _getCacheKey()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getCacheKey	(	$sType,
		$iLang = `null`,
		$iShopId = `null`,
		$sParams = `null`
	)

protected

Returns cache key (in non admin mode)

Parameters

string	$sType	object type
int	$iLang	active language id
mixed	$iShopId	active shop id
string	$sParams	additional seo params. optional (mostly used for db indexing)

Returns: string

◆ _getDynamicUri()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getDynamicUri	(	$sStdUrl,
		$sSeoUrl,
		$iLang
	)

protected

Returns dynamic object SEO URI

Parameters

string	$sStdUrl	standard url
string	$sSeoUrl	seo uri
int	$iLang	active language

Returns: string

◆ _getFullUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getFullUrl	(	$sSeoUrl,
		$iLang = `null`,
		$blSsl = `false`
	)

protected

Returns SEO url with shop's path + additional params ( \OxidEsales\Eshop\Core\SeoEncoder:: _getAddParams)

Parameters

string	$sSeoUrl	seo URL
int	$iLang	active language
bool	$blSsl	forces to build ssl url

Returns: string

◆ _getMaxUrlLength()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getMaxUrlLength ( )

protected

Returns maximum seo/dynamic url length

Returns: int

◆ _getPageUri()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getPageUri	(	$oObject,
		$sType,
		$sStdUrl,
		$sSeoUrl,
		$sParams,
		$iLang = `null`,
		$blFixed = `false`
	)

protected

Loads if exists or prepares and saves new seo url for passed object

Parameters

\OxidEsales\Eshop\Core\Model\BaseModel	$oObject	object to prepare seo data
string	$sType	type of object (oxvendor/oxcategory)
string	$sStdUrl	stanradr url
string	$sSeoUrl	seo uri
string	$sParams	additional params, liek page number etc. mostly used by mysql for indexes
int	$iLang	language
bool	$blFixed	fixed url marker (default is false)

Returns: string

◆ _getReservedEntryKeys()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getReservedEntryKeys ( )

protected

cached getter: check root directory php file names for them not to be in 1st part of seo url because then apache will execute that php file instead of url parser

Returns: array

◆ _getSeoIdent()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getSeoIdent ( $sSeoUrl )

protected

_getSeoIdent returns seo ident for db search

Parameters

string $sSeoUrl seo url

@access protected

Returns: string

◆ _getStaticObjectId()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getStaticObjectId	(	$iShopId,
		$sStdUrl
	)

protected

Generates static url object id

Parameters

int	$iShopId	shop id
string	$sStdUrl	standard (dynamic) url

Returns: string

◆ _getStaticUri()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getStaticUri	(	$sStdUrl,
		$iShopId,
		$iLang
	)

protected

Returns SEO static uri

Parameters

string	$sStdUrl	standard page url
int	$iShopId	active shop id
int	$iLang	active language

Returns: string

◆ _getUniqueSeoUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getUniqueSeoUrl	(	$sSeoUrl,
		$sObjectId = `null`,
		$iObjectLang = `null`
	)

protected

_getUniqueSeoUrl returns possibly modified url for not to be same as already existing in db

Parameters

string	$sSeoUrl	seo url
string	$sObjectId	current object id, used to skip self in query
int	$iObjectLang	object language id

@access protected

Returns: string

◆ _getUrlExtension()

OxidEsales\EshopCommunity\Core\SeoEncoder::_getUrlExtension ( )

protected

Returns target "extension"

Returns: null

◆ _isFixed()

OxidEsales\EshopCommunity\Core\SeoEncoder::_isFixed	(	$sType,
		$sId,
		$iLang,
		$iShopId = `null`,
		$sParams = `null`,
		$blStrictParamsCheck = `true`
	)

protected

check if seo url exist and is fixed

Parameters

string	$sType	object type
string	$sId	object identifier
int	$iLang	active language id
mixed	$iShopId	active shop id
string	$sParams	additional seo params. optional (mostly used for db indexing)
bool	$blStrictParamsCheck	strict parameters check

@access protected

Returns: bool

◆ _loadFromCache()

OxidEsales\EshopCommunity\Core\SeoEncoder::_loadFromCache	(	$sCacheIdent,
		$sType,
		$iLang = `null`,
		$iShopId = `null`,
		$sParams = `null`
	)

protected

Loads seo data from cache for active view (in non admin mode)

Parameters

string	$sCacheIdent	cache identifier
string	$sType	object type
int	$iLang	active language id
mixed	$iShopId	active shop id
string	$sParams	additional seo params. optional (mostly used for db indexing)

Returns: string

◆ _loadFromDb()

OxidEsales\EshopCommunity\Core\SeoEncoder::_loadFromDb	(	$sType,
		$sId,
		$iLang,
		$iShopId = `null`,
		$sParams = `null`,
		$blStrictParamsCheck = `true`
	)

protected

_loadFromDb loads data from oxseo table if exists returns oxseo url

Parameters

string	$sType	object type
string	$sId	object identifier
int	$iLang	active language id
mixed	$iShopId	active shop id
string	$sParams	additional seo params. optional (mostly used for db indexing)
bool	$blStrictParamsCheck	strict parameters check

@access protected

Returns: string || false

◆ _prepareTitle()

OxidEsales\EshopCommunity\Core\SeoEncoder::_prepareTitle	(	$sTitle,
		$blSkipTruncate = `false`,
		$iLang = `false`
	)

protected

Prepares and returns formatted object SEO id

Parameters

string	$sTitle	Original object title
bool	$blSkipTruncate	Truncate title into defined lenght or not
int	$iLang	language ID, for which to prepare the title

Returns: string

◆ _prepareUri()

OxidEsales\EshopCommunity\Core\SeoEncoder::_prepareUri	(	$sUri,
		$iLang = `false`
	)

protected

Makes safe seo uri - removes unsupported/reserved characters

Parameters

string	$sUri	seo uri
int	$iLang	language ID, for which URI should be prepared

Returns: string

◆ _processSeoUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::_processSeoUrl	(	$sSeoUrl,
		$sObjectId = `null`,
		$iLang = `null`,
		$blExclude = `false`
	)

protected

Processes seo url before saving to db:

\OxidEsales\Eshop\Core\SeoEncoder::addLanguageParam();
\OxidEsales\Eshop\Core\SeoEncoder::_getUniqueSeoUrl().

Parameters

string	$sSeoUrl	seo url to process
string	$sObjectId	seo object id [optional]
int	$iLang	active language id [optional]
bool	$blExclude	exclude language prefix while building seo url

Returns: string

◆ _saveInCache()

OxidEsales\EshopCommunity\Core\SeoEncoder::_saveInCache	(	$sCacheIdent,
		$sCache,
		$sType,
		$iLang = `null`,
		$iShopId = `null`,
		$sParams = `null`
	)

protected

Saves seo cache data for active view (in non admin mode)

Parameters

string	$sCacheIdent	cache identifier
string	$sCache	cacheable data
string	$sType	object type
int	$iLang	active language id
mixed	$iShopId	active shop id
string	$sParams	additional seo params. optional (mostly used for db indexing)

Returns: bool

◆ _saveToDb()

OxidEsales\EshopCommunity\Core\SeoEncoder::_saveToDb	(	$sType,
		$sObjectId,
		$sStdUrl,
		$sSeoUrl,
		$iLang,
		$iShopId = `null`,
		$blFixed = `null`,
		$sParams = `null`
	)

protected

_saveToDb saves values to seo table

Parameters

string	$sType	url type (static, dynamic, oxarticle etc)
string	$sObjectId	object identifier
string	$sStdUrl	standard url
string	$sSeoUrl	seo url
int	$iLang	active object language
mixed	$iShopId	active object shop id
bool	$blFixed	seo entry marker. if true, entry should not be automatically changed
string	$sParams	additional seo params. optional (mostly used for db indexing)

@access protected

Returns: mixed

◆ _trimUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::_trimUrl	(	$sUrl,
		$iLang = `null`
	)

protected

Removes shop path part and session id from given url

Parameters

string	$sUrl	url to clean bad chars
int	$iLang	active language

@access protected

Returns: string

◆ addLanguageParam()

OxidEsales\EshopCommunity\Core\SeoEncoder::addLanguageParam	(	$sSeoUrl,
		$iLang
	)

Returns part of url defining active language

Parameters

string	$sSeoUrl	seo url
int	$iLang	language id

Returns: string

◆ addSeoEntry()

OxidEsales\EshopCommunity\Core\SeoEncoder::addSeoEntry	(	$sObjectId,
		$iShopId,
		$iLang,
		$sStdUrl,
		$sSeoUrl,
		$sType,
		$blFixed = `1`,
		$sKeywords = `''`,
		$sDescription = `''`,
		$sParams = `''`,
		$blExclude = `false`,
		$sAltObjectId = `null`
	)

Adds new seo entry to db

Parameters

string	$sObjectId	objects id
int	$iShopId	shop id
int	$iLang	objects language
string	$sStdUrl	default url
string	$sSeoUrl	seo url
string	$sType	object type
bool	$blFixed	marker to keep seo config unchangeable
string	$sKeywords	seo keywords
string	$sDescription	seo description
string	$sParams	additional seo params. optional (mostly used for db indexing)
bool	$blExclude	exclude language prefix while building seo url
string	$sAltObjectId	alternative object id used while saving meta info (used to override object id when saving tags related info)

◆ assembleFullPageUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::assembleFullPageUrl	(	$object,
		$type,
		$stdUrl,
		$seoUrl,
		$pageNumber,
		$parameters,
		$languageId,
		$isFixed
	)

protected

Assemble full paginated url.

Parameters

\OxidEsales\Eshop\Application\Model\	$object	Object, atm category, vendor, manufacturer, recommendationList.
string	$type	Seo identifier, see oxseo.oxtype.
string	$stdUrl	Standard url
string	$seoUrl	Seo url
integer	$pageNumber	Number of the page which should be prepared.
string	$parameters	Additional parameters, mostly used by mysql for indices.
int	$languageId	Language id.
bool	$isFixed	Fixed url marker (default is null).

Returns: string

◆ copyStaticUrls()

OxidEsales\EshopCommunity\Core\SeoEncoder::copyStaticUrls ( $iShopId )

Method copies static urls from base shop to newly created

Parameters

int $iShopId new created shop id

◆ deleteSeoEntry()

OxidEsales\EshopCommunity\Core\SeoEncoder::deleteSeoEntry	(	$objectId,
		$shopId,
		$language,
		$type
	)

Remove a SEO entry from the database.

Parameters

string	$objectId	The id of the object to delete.
int	$shopId	The shop id of the object to delete.
int	$language	The language of the object to delete.
string	$type	The type of the object to delete.

◆ encodeStaticUrls()

OxidEsales\EshopCommunity\Core\SeoEncoder::encodeStaticUrls	(	$aStaticUrl,
		$iShopId,
		$iLang
	)

Static url encoder

Parameters

array	$aStaticUrl	static url info (contains standard URL and urls for each language)
int	$iShopId	active shop id
int	$iLang	active language

Exceptions

Exception

Returns: null

◆ encodeString()

OxidEsales\EshopCommunity\Core\SeoEncoder::encodeString	(	$sString,
		$blReplaceChars = `true`,
		$iLang = `false`
	)

Replaces special chars in text

Parameters

string	$sString	string to encode
bool	$blReplaceChars	is true, replaces user defined (\OxidEsales\Eshop\Core\Language::getSeoReplaceChars) characters into alternative
int	$iLang	language, for which to encode the string

Returns: string

◆ executeDatabaseQuery()

OxidEsales\EshopCommunity\Core\SeoEncoder::executeDatabaseQuery ( $query )

protected

Execute a query on the database.

Parameters

string $query The command to execute on the database.

◆ executeQuery()

OxidEsales\EshopCommunity\Core\SeoEncoder::executeQuery ( $query )

protected

Runs query. Returns false when the query fail, otherwise return true

Parameters

string $query Query to execute.

Returns: bool

◆ fetchSeoUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::fetchSeoUrl	(	$standardUrl,
		$languageId = `null`
	)

Searches for seo url in seo table. If not found - FALSE is returned

Parameters

string	$standardUrl
int	$languageId

Returns: string|false

◆ getDynamicObjectId()

OxidEsales\EshopCommunity\Core\SeoEncoder::getDynamicObjectId	(	$iShopId,
		$sStdUrl
	)

Generates dynamic url object id (calls \OxidEsales\Eshop\Core\SeoEncoder::_getStaticObjectId)

Parameters

int	$iShopId	shop id
string	$sStdUrl	standard (dynamic) url

Returns: string

◆ getDynamicUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::getDynamicUrl	(	$sStdUrl,
		$sSeoUrl,
		$iLang
	)

getDynamicUrl acts similar to static urls, except, that dynamic url are not shown in admin and they can be re-encoded by providing new seo url

Parameters

string	$sStdUrl	standard url
string	$sSeoUrl	part of URL query which will be attached to standard shop url
int	$iLang	active language

@access public

Returns: string

◆ getMetaData()

OxidEsales\EshopCommunity\Core\SeoEncoder::getMetaData	(	$sObjectId,
		$sMetaType,
		$iShopId = `null`,
		$iLang = `null`
	)

Returns meta information for preferred object

Parameters

string	$sObjectId	information object id
string	$sMetaType	metadata type - "oxkeywords", "oxdescription"
int	$iShopId	active shop id [optional]
int	$iLang	active language [optional]

Returns: string

◆ getStaticUrl()

OxidEsales\EshopCommunity\Core\SeoEncoder::getStaticUrl	(	$sStdUrl,
		$iLang = `null`,
		$iShopId = `null`
	)

Returns static url for passed standard link (if available)

Parameters

string	$sStdUrl	standard Url
int	$iLang	active language (optional). default null
int	$iShopId	active shop id (optional). default null

Returns: string

◆ markAsExpired()

OxidEsales\EshopCommunity\Core\SeoEncoder::markAsExpired	(	$sId,
		$iShopId = `null`,
		$iExpStat = `1`,
		$iLang = `null`,
		$sParams = `null`
	)

Marks object seo records as expired

Parameters

string	$sId	changed object id. If null is passed, object dependency is not checked
int	$iShopId	active shop id. Shop id must be passed uf you want to do shop level update (default null)
int	$iExpStat	expiration status: 1 - standard expiration
int	$iLang	active language (optiona;)
string	$sParams	additional params

◆ replaceSpecialChars()

OxidEsales\EshopCommunity\Core\SeoEncoder::replaceSpecialChars ( $stringWithSpecialChars )

protected

Searches for special characters in a string and replaces them with the configured strings.

Parameters

string $stringWithSpecialChars

Returns: string

◆ setIdLength()

OxidEsales\EshopCommunity\Core\SeoEncoder::setIdLength ( $iIdlength = null )

sets seo id length

Parameters

string $iIdlength id length

◆ setPrefix()

OxidEsales\EshopCommunity\Core\SeoEncoder::setPrefix ( $sPrefix )

Sets SEO prefix

Parameters

string $sPrefix SEO prefix

◆ setReservedWords()

OxidEsales\EshopCommunity\Core\SeoEncoder::setReservedWords ( $aReservedWords )

Sets array of words which must be checked before building seo url These words are appended by seo prefix if they are the initial uri segment

Parameters

array $aReservedWords reserved words

◆ setSeparator()

OxidEsales\EshopCommunity\Core\SeoEncoder::setSeparator ( $sSeparator = null )

Sets SEO separator

Parameters

string $sSeparator SEO seperator

Member Data Documentation

◆ $_aCache

OxidEsales\EshopCommunity\Core\SeoEncoder::$_aCache = []

staticprotected

◆ $_aFixedCache

OxidEsales\EshopCommunity\Core\SeoEncoder::$_aFixedCache = []

staticprotected

Url fixed state cache

Returns: array

◆ $_aReservedEntryKeys

OxidEsales\EshopCommunity\Core\SeoEncoder::$_aReservedEntryKeys = null

staticprotected

◆ $_aReservedWords

OxidEsales\EshopCommunity\Core\SeoEncoder::$_aReservedWords = ['admin']

staticprotected

◆ $_iIdLength

OxidEsales\EshopCommunity\Core\SeoEncoder::$_iIdLength = 255

protected

◆ $_iMaxUrlLength

OxidEsales\EshopCommunity\Core\SeoEncoder::$_iMaxUrlLength = null

protected

◆ $_sAddParams

OxidEsales\EshopCommunity\Core\SeoEncoder::$_sAddParams = null

protected

◆ $_sCacheKey

OxidEsales\EshopCommunity\Core\SeoEncoder::$_sCacheKey = null

staticprotected

◆ $_sPrefix

OxidEsales\EshopCommunity\Core\SeoEncoder::$_sPrefix = null

staticprotected

◆ $_sSeparator

OxidEsales\EshopCommunity\Core\SeoEncoder::$_sSeparator = null

staticprotected

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

/oxideshop-ce/source/Core/SeoEncoder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _copyToHistory()

◆ _getAltUri()

◆ _getCacheKey()

◆ _getDynamicUri()

◆ _getFullUrl()

◆ _getMaxUrlLength()

◆ _getPageUri()

◆ _getReservedEntryKeys()

◆ _getSeoIdent()

◆ _getStaticObjectId()

◆ _getStaticUri()

◆ _getUniqueSeoUrl()

◆ _getUrlExtension()

◆ _isFixed()

◆ _loadFromCache()

◆ _loadFromDb()

◆ _prepareTitle()

◆ _prepareUri()

◆ _processSeoUrl()

◆ _saveInCache()

◆ _saveToDb()

◆ _trimUrl()

◆ addLanguageParam()

◆ addSeoEntry()

◆ assembleFullPageUrl()

◆ copyStaticUrls()

◆ deleteSeoEntry()

◆ encodeStaticUrls()

◆ encodeString()

◆ executeDatabaseQuery()

◆ executeQuery()

◆ fetchSeoUrl()

◆ getDynamicObjectId()

◆ getDynamicUrl()

◆ getMetaData()

◆ getStaticUrl()

◆ markAsExpired()

◆ replaceSpecialChars()

◆ setIdLength()

◆ setPrefix()

◆ setReservedWords()

◆ setSeparator()

Member Data Documentation

◆ $_aCache

◆ $_aFixedCache

◆ $_aReservedEntryKeys

◆ $_aReservedWords

◆ $_iIdLength

◆ $_iMaxUrlLength

◆ $_sAddParams

◆ $_sCacheKey

◆ $_sPrefix

◆ $_sSeparator