The documentation is incomplete. The Vae Soli! team works hard to make it as exhaustive as possible with tons of useful examples and easy to understand explanations.
On top of that, we have decided to use our own tool to generate the documentation you read. This also takes time to fine-tune. Our goal is have better documentation, easier to read, easier to use, completely integrated with our site.
Even though NOT finalized, you can now link back to our documentation pages as we have decided once and for all about the structure of our documents and where they all reside on our server.
Thank you very much
The Vae Soli! team.
Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 12:50:00 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!
Assertions count: 0
Assertions successful: 0
Assertion failures: 0
LS_CONTENTS_COUNTDOWN_CLASS_PWH
: Define "LS" Contents Countdown (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSApplication.errors.inc
: Application error codes
LSV.functions.php
: Vae Soli! Foundation functions
LSContents.class.php
: LSContents class
LSContentsCountdown
extends LSContents
Creates and renders an island that displays countdown infoName | Visibility | Type | Description |
---|---|---|---|
$IsHidden |
public | bool | Determines whether the countdown must be kept hidden (false by default) |
$iStart |
public | int | Starting value of the countdown |
$szDest |
public | string | The destination to go to when 0 is reached |
$szTag |
public | string | Tag that must be used to surround the countdown |
$szTooltip |
public | string | Tooltip to display on the datetime |
LSContents
)Name | Type |
---|---|
Bandit |
boolean |
Cargo |
NULL |
GodStamp |
string |
IsDebug |
boolean |
PrefetchNext |
boolean |
PrefetchPrev |
boolean |
PrerenderNext |
boolean |
PrerenderPrev |
boolean |
Shelter |
NULL |
WithTOC |
boolean |
__LS_Consciousness |
NULL |
aAltStorages |
NULL |
aCookies |
array |
aErrors |
array |
aObjects |
NULL |
aStorages |
NULL |
aUserFields |
NULL |
bDraggable |
boolean |
bUserFieldsAfterStorage |
boolean |
bWithDiv |
boolean |
cargo |
NULL |
fPerf |
double |
fPerfThreshold |
double |
iCacheTTL |
integer |
iDelay |
integer |
id |
string |
mode |
string |
oApp |
NULL |
oCache |
NULL |
oEvaluator |
NULL |
oNode |
NULL |
oPage |
NULL |
oTracer |
NULL |
sessionPrefix |
string |
szAgora |
NULL |
szAltStorage |
NULL |
szCSSClass |
string |
szCallbackPost |
NULL |
szCallbackPre |
NULL |
szCloseButtonAlt |
NULL |
szCloseButtonImg |
NULL |
szCloseButtonTitle |
NULL |
szCss |
string |
szEventName |
NULL |
szExperiment |
boolean |
szGuid |
string |
szHeading |
string |
szLanguage |
string |
szName |
string |
szNow |
NULL |
szPostRenderingBlock |
NULL |
szPostXHTML |
NULL |
szPreRenderingBlock |
NULL |
szPreXHTML |
NULL |
szRoot |
string |
szSnippet |
string |
szStorage |
NULL |
szText |
NULL |
szTitle |
NULL |
szTitleHeading |
string |
szToday |
NULL |
szXSL |
NULL |
xEventValue |
NULL |
__construct()
: Class constructorFor the island to render correctly LSDates.js and LSStrings.js Javascripts must be loaded
Additional doc: /samples.php?pageref=multi-credentials#VAE-contents-countdown
__construct( $oPage,$oNode )
Name | Type | Description |
---|---|---|
$oPage |
LSPage | The page the countdown must be inserted in |
$oNode |
DOMNode | The georama node of the island |
(void)
<Island id="countdown" active="yes" class="LSContentsCountdown"> <param name="start">60</param> <param name="limit">0</param> <param name="CSSClass">datetime</param> <param name="destination">self</param> <param name="hidden">false</param> </Island>
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
RenderEdit()
: Renders the countdown island in 'edit' modeRenderEdit()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
RenderView()
: Renders the countdown island in 'view' modeRenderView()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).