Definition at line 7 of file oxseoencoder.php.
Public Member Functions | |
resetCache () | |
__construct () | |
encodeString ($sString, $blReplaceChars=true) | |
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= '') | |
deleteSeoEntry ($sObjectId, $iShopId, $iLang, $sType) | |
getMetaData ($sObjectId, $sMetaType, $iShopId=null, $iLang=null) | |
getDynamicUrl ($sStdUrl, $sSeoUrl, $iLang) | |
fetchSeoUrl ($sStdUrl, $iLanguage=null) | |
Static Public Member Functions | |
static | getInstance () |
Protected Member Functions | |
_copyToHistory ($sId, $iShopId, $iLang, $sType=null, $sNewId=null) | |
_getAddParams () | |
_getAddParamsFnc ($iCur, $iActShop) | |
_getDynamicObjectId ($iShopId, $sStdUrl) | |
_getDynamicUri ($sStdUrl, $sSeoUrl, $iLang) | |
_getFullUrl ($sSeoUrl, $iLang=null) | |
_getSeoIdent ($sSeoUrl, $iLang=null) | |
_getStaticUri ($sStdUrl, $iShopId, $iLang) | |
_getUniqueSeoUrl ($sSeoUrl, $sConstEnd=null, $sObjectId=null, $iObjectLang=null) | |
_loadFromDb ($sType, $sId, $iLang, $iShopId=null, $sParams=null, $blStrictParamsCheck=true) | |
_getReservedEntryKeys () | |
_prepareTitle ($sTitle, $blSkipTruncate=false) | |
_saveToDb ($sType, $sObjectId, $sStdUrl, $sSeoUrl, $iLang, $iShopId=null, $blFixed=null, $sKeywords=false, $sDescription=false, $sParams=null) | |
_trimUrl ($sUrl, $iLang=null) | |
_getPageUri ($oObject, $sType, $sStdUrl, $sSeoUrl, $sParams, $iLang=null, $blFixed=false) | |
_getStaticObjectId ($iShopId, $sStdUrl) | |
Protected Attributes | |
$_iIdLength = 255 | |
$_sAddParams = null | |
$_aSeoCache = array() | |
Static Protected Attributes | |
static | $_aReservedWords = array( 'admin' ) |
static | $_aReservedEntryKeys = null |
static | $_sSeparator = null |
static | $_sPrefix = null |
static | $_instance = null |
oxSeoEncoder.__construct | ( | ) |
SEO encoder constructor
Definition at line 98 of file oxseoencoder.php.
static oxSeoEncoder.getInstance | ( | ) | [static] |
Singleton method
Reimplemented in oxSeoEncoderArticle, oxSeoEncoderCategory, oxSeoEncoderContent, oxSeoEncoderManufacturer, oxSeoEncoderTag, and oxSeoEncoderVendor.
Definition at line 71 of file oxseoencoder.php.
oxSeoEncoder.resetCache | ( | ) |
Resets seo cache (use in case you need forced reset)
Definition at line 90 of file oxseoencoder.php.
oxSeoEncoder._copyToHistory | ( | $ | sId, | |
$ | iShopId, | |||
$ | iLang, | |||
$ | sType = null , |
|||
$ | sNewId = null | |||
) | [protected] |
Moves current seo record to seo history table
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) |
Definition at line 121 of file oxseoencoder.php.
oxSeoEncoder._getAddParams | ( | ) | [protected] |
Returns string for SEO url with specific parameters (language, currency and active shop)
Definition at line 138 of file oxseoencoder.php.
oxSeoEncoder._getAddParamsFnc | ( | $ | iCur, | |
$ | iActShop | |||
) | [protected] |
Returns string for SEO url with specific parameters (language, currency and active shop)
integer | $iCur shop currency | |
mixed | $iActShop active shop id |
Definition at line 156 of file oxseoencoder.php.
oxSeoEncoder._getDynamicObjectId | ( | $ | iShopId, | |
$ | sStdUrl | |||
) | [protected] |
Generates dynamic url object id (calls oxseoencoder._getStaticObjectId)
int | $iShopId shop id | |
string | $sStdUrl standard (dynamic) url |
Definition at line 178 of file oxseoencoder.php.
oxSeoEncoder._getDynamicUri | ( | $ | sStdUrl, | |
$ | sSeoUrl, | |||
$ | iLang | |||
) | [protected] |
Returns dynamic object SEO URI
string | $sStdUrl standart url | |
string | $sSeoUrl seo uri | |
int | $iLang active language |
Definition at line 192 of file oxseoencoder.php.
oxSeoEncoder._getFullUrl | ( | $ | sSeoUrl, | |
$ | iLang = null | |||
) | [protected] |
Returns SEO url with shop's path + additional params ( oxseoencoder:: _getAddParams)
string | $sSeoUrl seo URL | |
int | $iLang active language (deprecated - does nothing) |
Definition at line 229 of file oxseoencoder.php.
oxSeoEncoder._getSeoIdent | ( | $ | sSeoUrl, | |
$ | iLang = null | |||
) | [protected] |
_getSeoIdent returns seo ident for db search
string | $sSeoUrl seo url | |
int | $iLang active language (deprecated - does nothing) |
Definition at line 245 of file oxseoencoder.php.
oxSeoEncoder._getStaticUri | ( | $ | sStdUrl, | |
$ | iShopId, | |||
$ | iLang | |||
) | [protected] |
Returns SEO static uri
string | $sStdUrl standard page url | |
int | $iShopId active shop id | |
int | $iLang active language |
Definition at line 259 of file oxseoencoder.php.
oxSeoEncoder._getUniqueSeoUrl | ( | $ | sSeoUrl, | |
$ | sConstEnd = null , |
|||
$ | sObjectId = null , |
|||
$ | iObjectLang = null | |||
) | [protected] |
_getUniqueSeoUrl returns possibly modified url for not to be same as already existing in db
string | $sSeoUrl seo url | |
string | $sConstEnd target "extension" - ".html" or "/" | |
string | $sObjectId current object id, used to skip self in query | |
int | $iObjectLang object language id |
Definition at line 278 of file oxseoencoder.php.
oxSeoEncoder._loadFromDb | ( | $ | sType, | |
$ | sId, | |||
$ | iLang, | |||
$ | iShopId = null , |
|||
$ | sParams = null , |
|||
$ | blStrictParamsCheck = true | |||
) | [protected] |
_loadFromDb loads data from oxseo table if exists returns oxseo url
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 |
Definition at line 349 of file oxseoencoder.php.
oxSeoEncoder._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
Definition at line 404 of file oxseoencoder.php.
oxSeoEncoder._prepareTitle | ( | $ | sTitle, | |
$ | blSkipTruncate = false | |||
) | [protected] |
Prepares and returns formatted object SEO id
string | $sTitle Original object title | |
bool | $blSkipTruncate Truncate title into defined lenght or not |
Definition at line 429 of file oxseoencoder.php.
oxSeoEncoder._saveToDb | ( | $ | sType, | |
$ | sObjectId, | |||
$ | sStdUrl, | |||
$ | sSeoUrl, | |||
$ | iLang, | |||
$ | iShopId = null , |
|||
$ | blFixed = null , |
|||
$ | sKeywords = false , |
|||
$ | sDescription = false , |
|||
$ | sParams = null | |||
) | [protected] |
_saveToDb saves values to seo table
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 | $sKeywords object keywords | |
string | $sDescription object description | |
string | $sParams additional seo params. optional (mostly used for db indexing) |
Definition at line 499 of file oxseoencoder.php.
oxSeoEncoder._trimUrl | ( | $ | sUrl, | |
$ | iLang = null | |||
) | [protected] |
Removes shop path part and session id from given url
string | $sUrl url to clean bad chars | |
int | $iLang active language (deprecated - does nothing) |
Definition at line 574 of file oxseoencoder.php.
oxSeoEncoder.encodeString | ( | $ | sString, | |
$ | blReplaceChars = true | |||
) |
Replaces special chars in text
string | $sString string to encode | |
bool | $blReplaceChars is true, replaces user defined (oxconfig.aSeoReplaceChars) characters into alternative |
Definition at line 588 of file oxseoencoder.php.
oxSeoEncoder.setSeparator | ( | $ | sSeparator = null |
) |
Sets SEO separator
string | $sSeparator SEO seperator |
Definition at line 610 of file oxseoencoder.php.
oxSeoEncoder.setPrefix | ( | $ | sPrefix | ) |
Sets SEO prefix
string | $sPrefix SEO prefix |
Definition at line 625 of file oxseoencoder.php.
oxSeoEncoder.setIdLength | ( | $ | iIdlength = null |
) |
sets seo id length
string | $iIdlength id length |
Definition at line 641 of file oxseoencoder.php.
oxSeoEncoder.setReservedWords | ( | $ | aReservedWords | ) |
Sets array of words which must be checked before building seo url
array | $aReservedWords reserved words |
Definition at line 655 of file oxseoencoder.php.
oxSeoEncoder.markAsExpired | ( | $ | sId, | |
$ | iShopId = null , |
|||
$ | iExpStat = 1 , |
|||
$ | iLang = null , |
|||
$ | sParams = null | |||
) |
Marks object seo records as expired
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, 2 - seo primary language id expiration | |
int | $iLang active language (optiona;) | |
string | $sParams additional params |
Definition at line 672 of file oxseoencoder.php.
oxSeoEncoder._getPageUri | ( | $ | oObject, | |
$ | sType, | |||
$ | sStdUrl, | |||
$ | sSeoUrl, | |||
$ | sParams, | |||
$ | iLang = null , |
|||
$ | blFixed = false | |||
) | [protected] |
Loads if exists or prepares and saves new seo url for passed object
oxbase | $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) |
Definition at line 696 of file oxseoencoder.php.
oxSeoEncoder._getStaticObjectId | ( | $ | iShopId, | |
$ | sStdUrl | |||
) | [protected] |
Generates static url object id
int | $iShopId shop id | |
string | $sStdUrl standard (dynamic) url |
Definition at line 726 of file oxseoencoder.php.
oxSeoEncoder.encodeStaticUrls | ( | $ | aStaticUrl, | |
$ | iShopId, | |||
$ | iLang | |||
) |
Static url encoder
array | $aStaticUrl static url info (contains standard URL and urls for each language) | |
int | $iShopId active shop id | |
int | $iLang active language |
Definition at line 740 of file oxseoencoder.php.
oxSeoEncoder.copyStaticUrls | ( | $ | iShopId | ) |
Method copies static urls from base shop to newly created
int | $iShopId new created shop id |
Definition at line 812 of file oxseoencoder.php.
oxSeoEncoder.getStaticUrl | ( | $ | sStdUrl, | |
$ | iLang = null , |
|||
$ | iShopId = null | |||
) |
Returns static url for passed standard link (if available)
string | $sStdUrl standard Url | |
int | $iLang active language (optional). default null | |
int | $iShopId active shop id (optional). default null |
Definition at line 835 of file oxseoencoder.php.
oxSeoEncoder.addSeoEntry | ( | $ | sObjectId, | |
$ | iShopId, | |||
$ | iLang, | |||
$ | sStdUrl, | |||
$ | sSeoUrl, | |||
$ | sType, | |||
$ | blFixed = 1 , |
|||
$ | sKeywords = '' , |
|||
$ | sDescription = '' , |
|||
$ | sParams = '' | |||
) |
Adds new seo entry to db
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) |
Definition at line 867 of file oxseoencoder.php.
oxSeoEncoder.deleteSeoEntry | ( | $ | sObjectId, | |
$ | iShopId, | |||
$ | iLang, | |||
$ | sType | |||
) |
Removes seo entry from db
string | $sObjectId objects id | |
int | $iShopId shop id | |
int | $iLang objects language | |
string | $sType object type |
Definition at line 883 of file oxseoencoder.php.
oxSeoEncoder.getMetaData | ( | $ | sObjectId, | |
$ | sMetaType, | |||
$ | iShopId = null , |
|||
$ | iLang = null | |||
) |
Returns meta information for preferred object
string | $sObjectId information object id | |
string | $sMetaType metadata type - "oxkeywords", "oxdescription" | |
int | $iShopId active shop id | |
int | $iLang active language |
Definition at line 899 of file oxseoencoder.php.
oxSeoEncoder.getDynamicUrl | ( | $ | sStdUrl, | |
$ | sSeoUrl, | |||
$ | iLang | |||
) |
getDynamicUrl acts similar to static urls, except, that dynamic url are not shown in admin and they can be reencoded by providing new seo url
string | $sStdUrl standard url | |
string | $sSeoUrl part of URL query which will be attached to standard shop url | |
int | $iLang active language |
Definition at line 920 of file oxseoencoder.php.
oxSeoEncoder.fetchSeoUrl | ( | $ | sStdUrl, | |
$ | iLanguage = null | |||
) |
Searches for seo url in seo table. If not found - FALSE is returned
string | $sStdUrl standard url | |
integer | $iLanguage language |
Definition at line 933 of file oxseoencoder.php.
oxSeoEncoder.$_aReservedWords = array( 'admin' ) [static, protected] |
Definition at line 15 of file oxseoencoder.php.
oxSeoEncoder.$_aReservedEntryKeys = null [static, protected] |
Definition at line 22 of file oxseoencoder.php.
oxSeoEncoder.$_sSeparator = null [static, protected] |
Definition at line 29 of file oxseoencoder.php.
oxSeoEncoder.$_iIdLength = 255 [protected] |
Definition at line 36 of file oxseoencoder.php.
oxSeoEncoder.$_sPrefix = null [static, protected] |
Definition at line 43 of file oxseoencoder.php.
oxSeoEncoder.$_sAddParams = null [protected] |
Definition at line 50 of file oxseoencoder.php.
oxSeoEncoder.$_instance = null [static, protected] |
Reimplemented in oxSeoEncoderArticle, oxSeoEncoderCategory, oxSeoEncoderContent, oxSeoEncoderManufacturer, oxSeoEncoderTag, and oxSeoEncoderVendor.
Definition at line 57 of file oxseoencoder.php.
oxSeoEncoder.$_aSeoCache = array() [protected] |
Definition at line 64 of file oxseoencoder.php.