Knowledgebase: Design Templates
Flags available within cmsinclude.ini.php
Posted by - NA -, Last modified by Mark [Elevated X Support] on 25 October 2016 12:05 AM

Flags available within cmsinclude.ini.php

Here are a list of the current flags available within cmsinclude.ini.php.

Note - Some flags may only be supported by certain versions and may not work with older versions of the software. Use of these flags is only suggested for advanced users and may only apply to customizations made to XSL or Smarty templates. Support of the features listed here are not routinely considered part of our standard product support and additional support charges may apply for assistance with these features.


ADMINPREVIEW
If set to 1, shows all content in the future.  This is put in place so you can potentially set up an internal members area to preview new content before it's released to the public.

ALLSITES_EXCLUDE
On the index page, exclude these All Access sites from being listed.

AUTHFUNC
By default, ElevatedX determines what user is logged in by looking at the value of $_SERVER["PHP_AUTH_USER"].  If set, the system will instead look at a user-defined function that returns the username.
This is useful if the user is using third-party authentication, or internally developed authentication.  Note: Strongbox users won't need to use this function as StrongBox sets the value of $_SERVER["PHP_AUTH_USER"];

CACHE_LOCATION
By default, the CMS stores any cached files within the location /cms_admin/storage/cache/ However, if you have multiple servers, you MAY increase performance by storing your cached files locally instead of reading them over a network.  This variable lets you set the cache location.

CACHEDEPENDENCY_FUNC
This flag allows you to integrate custom code that lets you do manipulate the cache engine that the system uses.  You can find out more about this use under "Integrating Custom PHP Code" here:
https://support.elevatedx.com/index.php?/Knowledgebase/Article/View/85/0/integrate-custom-php-code

CACHE_GETVARS
By default, the system's caching system uses a list of parameters that specifies whether or not a cached copy of the page should be loaded, or a new page should be generated.
Sometimes, if a custom template is being used, a variable such as {$smarty.get.varname} might be used. This, however, is not recognized by our caching system. In order to mitigate this, CACHE_GETVARS allows a comma delimited list of $_GET variables that should be added to the caching engine.

CACHE_POSTVARS
By default, the system's caching system uses a list of parameters that specifies whether or not a cached copy of the page should be loaded, or a new page should be generated.
Sometimes, if a custom template is being used, a variable such as {$smarty.post.varname} might be used. This, however, is not recognized by our caching system. In order to mitigate this, CACHE_POSTVARS allows a comma delimited list of $_POST variables that should be added to the caching engine.

CACHE_COOKIEVARS
By default, the system's caching system uses a list of parameters that specifies whether or not a cached copy of the page should be loaded, or a new page should be generated.
Sometimes, if a custom template is being used, a variable such as {$smarty.cookie.varname} might be used. This, however, is not recognized by our caching system. In order to mitigate this, CACHE_COOKIEVARS allows a comma delimited list of $_COOKIE variables that should be added to the caching engine.

CACHE_REQUESTVARS
By default, the system's caching system uses a list of parameters that specifies whether or not a cached copy of the page should be loaded, or a new page should be generated.
Sometimes, if a custom template is being used, a variable such as {$smarty.request.varname} might be used. This, however, is not recognized by our caching system. In order to mitigate this, CACHE_REQUESTVARS allows a comma delimited list of $_REQUEST variables that should be added to the caching engine.

CALENDAR_ADDSITES
If set, includes other All-Access sites within the calendar apart from the standard site.

CATEGORY_ALLSITES
In an All-Access Setup, if this is set to 1, display all content from all All Access Sites instead of just content from the one All-Access Subsite.

CATEGORY_SORTSITEFIRST
If CATEGORY_ALLSITES is set to 1 and CATEGORY_SORTSITEFIRST is set to 1, show all content from all sites within All-Access, but display content from the folder's All-Access site id first.

COMINGSOON_OTHERSITEUPDATES
If set to 1, allows within the XML Document / Smarty Array to display future content from All-Access sites other than the current site.

DEFAULTLANGUAGE
By default, the system language served to a user logging into the site is LANGUAGE=0 (Generally English).  However, if you have multi-language support, you can use this flag to set the default language this area will load. It will still allow users to select other languages via a drop down.

Note: This cannot be used with the LANGUAGE flag.

HIDE_MEDIATYPES
If set, allows the system to hide specific media types from showing within a specific members / trial area.

INDEXLIST_LIMITMODEL
If set to 1, limit all index updates to this specific Model Id number.  E.g: If "Jane" is Model Id 7, setting INDEXLIST_LIMITMODEL to 7 will only show updates from "Jane" on the front page.

INDEX_OTHERSITEUPDATES
If this value is set, add to the XML Document / Smarty Array the ability to list updates from separate sites on the index page. e.g: If this value is set to "1,2:3,4", this will create two separate lists: One with sites 1 and 2, and the other with sites 3,4.

LANGUAGE
By default, the system language served to a user logging into the site is LANGUAGE=0 (Generally English).  However, if you have multi-language support, you can use this flag to set the language this area will load. It will disable the user from being able to select another language from the drop down.

Note: This cannot be used with the DEFAULTLANGUAGE flag.

MOBILE
If set to 1, turns off detection and unconditionally loads a mobile area / template.
If set to 0, turns off detection and unconditionally loads a desktop area / template.

MOBILE_SMARTY_FOLDER
If set, overrides the template folder used by the system when a mobile area is loaded.

MOBILE_TEMPLATELANGUAGE
If set, overrides the default template language used by the system when a mobile area is loaded.  Valid values are "xsl" and "smarty" (both must be lower case)

MODEL_GENDERLIMIT
If set, limits the model listing page to either Male or Female models. Valid values here are M or F.

NOOFFERS
If this value is set to 1, this area will not show any full page offers.

POSTPROCESS
This flag allows you to integrate custom code that lets you do alterations on any HTML that the system returns before printing it out.  You can find out more about this use under "Integrating Custom PHP Code" here:
 http://support.elevatedx.com/index.php?_m=knowledgebase&_a=viewarticle&kbarticleid=123

PUBLICAREA
If PUBLICAREA is set to 1, the system treats this area as public.  Within plugins such as News, one can set released content for either the internal members area, public area, or both.  Also, it is possible to go into setup and configure different templates to be used specifically for the public area.

REDIRECT_DESKTOP
If this value is set, redirect a desktop user to a separate URL. This way, this specific folder is only viewable to mobile devices.
Note: This cannot be used with the MOBILE flag being set.

REDIRECT_MOBILE
If this value is set, redirect a mobile user to a separate URL. This way, this specific folder is only viewable to desktop devices.
Note: This cannot be used with the MOBILE flag being set.

RSS
If this value is set to 1, load the RSS feed by default. This is useful if you're looking to have your RSS feed specifically within a separate folder. (e.g: /rss/)

SEARCH_OVERRIDEQUERY (deprecated)
This flag allows you to override the search query the system uses in case you wish to change the way searches are done via the database. In this case, you can define a custom function that will override search.php functionality and perform its own query against the database. The custom function should return the result set of the query you perform within the function. This result set is in an array form, and in Smarty is what gets populated in $root.page.results.result.

The hook for this system is similar to the POSTPROCESS flag used by the system. You can see more information on that here:
https://support.elevatedx.com/index.php?/Knowledgebase/Article/View/85/0/integrate-custom-php-code

SMARTY_FOLDER
If set, overrides the template folder used by the system.

SUBSITE_ID
If set, determines which site within all-access this members area folder should display.

TEMPLATELANGUAGE
If set, overrides the default template language used by the system.  Valid values are "xsl" and "smarty" (both must be lower case)

TOUR_ID
If set, determines which tour within the tour-plugin this area is using.

TRIAL
If set, determines which trial within the trial-plugin this area is using.

XSL_FOLDER
If set, overrides the template folder used by the system.

(2 vote(s))
Helpful
Not helpful

Comments (0)