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 13:08:44 (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_MODULE_ABSTRACT_CLASS_PWH
: Define "LS" module abstract class (Pat Was Here)
VAESOLI_PATH
: Define the path where Vae Soli! is installed
VAESOLI_PLUGINS
: Define the path where plugins are located
LSV.functions.php
: Framework global functions
LSContents.class.php
: High Level Content class
LSModuleAbstract
extends LSContents
Abstraction of display services of records of a given module.Name | Visibility | Type | Description |
---|---|---|---|
$iMaxLength |
public | int | Maximum number of charcaters to display when showing an item of the module |
$szGenericFilter |
public | string | Generic filter |
$szImageDir |
public | string | Directory where items images are stored |
$szImgOnClick |
public | string | onclick clause that is triggered when the image of an item is clicked |
$szImgOnMouseOut |
public | string | onmouseout clause when leaving the image area |
$szImgOnMouseOver |
public | string | onmouseout clause when hovering the image area |
$szInnerTitle |
public | string | Inner totle |
$szModule |
public | string | The name of the module |
$szMore |
public | string | URL of the age to go to when "more" is clicked |
$szMoreMark |
public | string | Mark used to represent "more" |
$szOrderBy |
public | string | The orderBy clause when the records of the module must be displayed |
$szOrderDir |
public | string | Direction of the sort. 'ascending' by default |
$szViewType |
public | string | Way the module must be viewed |
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 constructor__construct( $oPage,$oNode )
Name | Type | Description |
---|---|---|
$oPage |
LSPage | The page in which the records of the module must be displayed |
$oNode |
DOMNode | The georama node of the island |
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
Browse()
: Renders the records of the module in a BROWSE. Abstract method.Browse()
None
(void)
WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}
) or with GuideAssert()
function calls in exec constructs ({*exec ... *}
).
RenderEdit()
: Renders the records of the module island in 'edit' modeRecords are ALWAYS rendered in 'view' mode (14-09-13 11:53:57)
RenderEdit()
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 records of the module 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 ... *}
).