PHP Class BxDolSiteMaps, dolphin.pro

To add sitemap to your module you need to add a record to 'sys_objects_site_maps' table and custom class: id - autoincremented id for internal usage object - your unique module name, with vendor prefix, lowercase and spaces are underscored priority - priority, allowed values from 0.0 to 1.0 changefreq - how frequently contents change, allowed values: always, hourly, daily, weekly, monthly, yearly, never class_name - your custom class name class_file - file where your class_name is stored order - order in which this sitemap is generated active - is object active, allowed values 0 or 1 You can refer to BoonEx modules for sample record in this table.
Afficher le fichier Open project: boonex/dolphin.pro Class Usage Examples

Protected Properties

Свойство Type Description
$BASE_PATH
$BASE_PATH_INDEX url to generated sitemaps
$BASE_URL path to generated sitemaps
$BASE_URL_INDEX path to generated index sitemap
$_aQueryParts
$_aSystem url to generated index sitemap
$_oQuery current sitemap system array

Méthodes publiques

Méthode Description
deleteAllSiteMaps ( ) delete all sitemaps
generate ( ) generate files for current
generateAllSiteMaps ( ) it is called on cron every day or similar period to generate sitemaps from all modules
getObjectInstance ( $sObject ) : object Get sitemap object instance by object name
getSiteMapIndexPath ( ) get sitemaps index file path
getSiteMapIndexUrl ( ) get sitemaps index file url
getSystems ( ) get all systems

Méthodes protégées

Méthode Description
__construct ( $aSystem )
_escape ( $s )
_formatDate ( $iTimestamp )
_genChangeFreq ( $a )
_genDate ( $a )
_genUrl ( $a )
_genXmlUrl ( $a )
_genXmlUrlsBegin ( )
_genXmlUrlsEnd ( )
_getCount ( )
_getDateTimeStamp ( $a )
_getRecords ( $iStart )

Method Details

__construct() protected méthode

protected __construct ( $aSystem )

_escape() protected static méthode

protected static _escape ( $s )

_formatDate() protected static méthode

protected static _formatDate ( $iTimestamp )

_genChangeFreq() protected méthode

protected _genChangeFreq ( $a )

_genDate() protected méthode

protected _genDate ( $a )

_genUrl() protected méthode

protected _genUrl ( $a )

_genXmlUrl() protected méthode

protected _genXmlUrl ( $a )

_genXmlUrlsBegin() protected méthode

protected _genXmlUrlsBegin ( )

_genXmlUrlsEnd() protected méthode

protected _genXmlUrlsEnd ( )

_getCount() protected méthode

protected _getCount ( )

_getDateTimeStamp() protected méthode

protected _getDateTimeStamp ( $a )

_getRecords() protected méthode

protected _getRecords ( $iStart )

deleteAllSiteMaps() public static méthode

delete all sitemaps
public static deleteAllSiteMaps ( )

generate() public méthode

generate files for current
public generate ( )

generateAllSiteMaps() public static méthode

it is called on cron every day or similar period to generate sitemaps from all modules
public static generateAllSiteMaps ( )

getObjectInstance() public static méthode

Get sitemap object instance by object name
public static getObjectInstance ( $sObject ) : object
$sObject object name
Résultat object instance or false on error

getSiteMapIndexPath() public static méthode

get sitemaps index file path
public static getSiteMapIndexPath ( )

getSiteMapIndexUrl() public static méthode

get sitemaps index file url
public static getSiteMapIndexUrl ( )

getSystems() public static méthode

get all systems
public static getSystems ( )

Property Details

$BASE_PATH protected_oe static_oe property

protected static $BASE_PATH

$BASE_PATH_INDEX protected_oe static_oe property

url to generated sitemaps
protected static $BASE_PATH_INDEX

$BASE_URL protected_oe static_oe property

path to generated sitemaps
protected static $BASE_URL

$BASE_URL_INDEX protected_oe static_oe property

path to generated index sitemap
protected static $BASE_URL_INDEX

$_aQueryParts protected_oe property

protected $_aQueryParts

$_aSystem protected_oe property

url to generated index sitemap
protected $_aSystem

$_oQuery protected_oe property

current sitemap system array
protected $_oQuery