Niouzes

< Janvier 2022 >
Lu Ma Me Je Ve Sa Di
          1 2
3 4 5 6 7 8 9
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
31            

Citation

Attention

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.

2020-01-18 à 01:24:43

Table Of Contents

  1. FOUNDATION (functions) (01/04/2015)
  2. LSAction (class) (01/04/2015)
  3. LSAddress (class) (01/04/2015)
  4. LSAdministrativeArea (class) (01/04/2015)
  5. LSApplication (class) (14/10/2013)
  6. LSArray (class) (14/10/2013)
  7. LSArticle (class) (18/02/2014)
  8. LSAssertion (class) (14/10/2013)
  9. LSAudience (class) (18/02/2014)
  10. AUTOLOAD (function) (21/04/2014)
  11. LSAutoReference (class) (14/10/2013)
  12. LSBag (class) (14/10/2013)
  13. LSBBCodes (class) (10/06/2014)
  14. LSBrowser (class) (14/10/2013)
  15. LSCache (class) (14/10/2013)
  16. LSCalculator (class) (14/10/2013)
  17. LSCalendar (class) (14/10/2013)
  18. LSCameraSnapshot (class) (14/10/2013)
  19. LSCitation (class) (14/10/2013)
  20. LSClass (class) (14/10/2013)
  21. LSCode (class) ()
  22. Colors (functions) (18/01/2020)
  23. LSContactForm (class) (14/10/2013)
  24. LSContainer (class) (14/10/2013)
  25. LSContents (class) (14/10/2013)
  26. LSContentsAccounts (class) (14/10/2013)
  27. LSContentsArticles (class) (14/10/2013)
  28. LSContentsAtomicClock (class) (14/10/2013)
  29. LSContentsBusinessCoordinates (class) (14/10/2013)
  30. LSContentsBusinessOff (class) (14/10/2013)
  31. LSContentsBusinessOpeningHours (class) (14/10/2013)
  32. LSContentsBreadcrumb (class) (14/10/2013)
  33. LSContentsCalendar (class) (14/10/2013)
  34. LSContentsCatalogue (class) (14/10/2013)
  35. LSContentsCharter (class) (18/02/2014)
  36. LSContentsCitation (class) (14/10/2013)
  37. LSContentsClock (class) (14/10/2013)
  38. LSContentsComments (class) (14/10/2013)
  39. LSContentsCookieUsage (class) (14/10/2013)
  40. LSContentsCountdown (class) (14/10/2013)
  41. LSContentsDatetime (class) (14/10/2013)
  42. LSContentsHeartbeat (class) (14/10/2013)
  43. LSContentsIFrame (class) (14/10/2013)
  44. LSContentsImageGallery (class) (14/10/2013)
  45. LSContentsLanguageSwitchers (class) (14/10/2013)
  46. LSContentsLegal (class) (18/02/2014)
  47. LSContentsMicronews (class) (14/10/2013)
  48. LSContentsMyAccount (class) (14/10/2013)
  49. LSContentsPaymentOptions (class) (14/10/2013)
  50. LSContentsPinboard (class) (14/10/2013)
  51. LSContentsRememberPassword (class) (14/10/2013)
  52. LSContentsRSS (class) (14/10/2013)
  53. LSContentsSiteManager (class) (14/10/2013)
  54. LSContentsSitemap (class) (14/10/2013)
  55. LSContentsShare (class) (14/10/2013)
  56. LSContentsStopwatch (class) (14/10/2013)
  57. LSContentsTagCloud (class) (14/10/2013)
  58. LSContentsTodosOnPage (class) (14/10/2013)
  59. LSContentsW3C (class) (14/10/2013)
  60. LSContentsWeather (class) (14/10/2013)
  61. LSControl (class) (14/10/2013)
  62. LSCreativeWork (class) (18/02/2014)
  63. LSCursor (class) (09/03/2015)
  64. LSCustomer (class) (14/10/2013)
  65. LSDataEnvironment (class) (14/10/2013)
  66. Dates (functions) (01/04/2015)
  67. LSDate (class) (14/10/2013)
  68. LSDictionary (class) (14/10/2013)
  69. LSDom, LSDomNode and LSXPath (class) (30/04/2014)
  70. LSErrors and LSError (classes) (14/10/2013)
  71. LSException (class) (16/10/2013)
  72. LSExplorer (class) (14/10/2013)
  73. LSFieldset (class) (14/10/2013)
  74. LSFile (class) (14/10/2013)
  75. LSFileProperties (class) (14/10/2013)
  76. Files (functions) (01/04/2015)
  77. Finance (functions) (01/04/2015)
  78. LSFootnotes (class) (22/02/2014)
  79. LSForm (class) (09/06/2014)
  80. LSFunction (class) (14/10/2013)
  81. LSGeorama (class) (24/10/2013)
  82. LSGeoramaVar (class) (24/10/2013)
  83. LSGlossary (class) (09/03/2015)
  84. LSGroup (class) (14/10/2013)
  85. HTML (functions) (01/04/2015)
  86. LSHttp (class) (14/10/2013)
  87. HTTP (functions) (01/04/2015)
  88. LSImageGallery (class) (14/10/2013)
  89. Images (functions) (01/04/2015)
  90. LSInput (class) (26/04/2014)
  91. IP (functions) (01/04/2015)
  92. LSIslandAbstract (14/10/2013)
  93. LSIslandFormAbstract (class) (14/10/2013)
  94. LSLabel (class) (14/10/2013)
  95. LSLanguageSwitchers (class) (14/10/2013)
  96. LSLatin (class) (14/10/2013)
  97. LSLegalPerson (class) (14/10/2013)
  98. LSLinkedList (class) (14/10/2013)
  99. LSList (class) (14/10/2013)
  100. Mails (functions) (01/04/2015)
  101. LSMap (class) (14/10/2013)
  102. Math (functions) (01/04/2015)
  103. LSMicronews (class) (18/02/2014)
  104. Miscellaneous (functions) (01/04/2015)
  105. LSModuleAbstract (class) (14/10/2013)
  106. LSNaturalPerson (class) (14/10/2013)
  107. LSNewsArticle (class) (18/02/2014)
  108. LSNote (class) (14/10/2013)
  109. LSMotherNature (class) (16/10/2013)
  110. LSPage (class) (18/02/2014)
  111. LSParameter (class) (14/10/2013)
  112. LSPaymentOptions (class) (14/10/2013)
  113. LSPeopleAudience (class) (18/02/2014)
  114. LSPerson (class) (14/10/2013)
  115. LSPlace (class) (18/02/2014)
  116. LSProperty (class) (14/10/2013)
  117. LSPublication (class) (14/10/2013)
  118. LSRequirement (class) (14/10/2013)
  119. LSReturn (class) (24/10/2013)
  120. LSRisk (class) (14/10/2013)
  121. LSSentanaiAbstract (14/10/2013)
  122. LSServiceMessage (class) (14/10/2013)
  123. LSSession (class) (14/10/2013)
  124. LSSiteManager (class) (14/10/2013)
  125. LSSitemap (class) (14/10/2013)
  126. LSSockets (class) (14/10/2013)
  127. LSSoftwareApplication (class) (18/02/2014)
  128. LSSource (class) (14/10/2013)
  129. Strings (functions) (31/07/2016)
  130. LSSupplier (class) (14/10/2013)
  131. System (functions) (01/04/2015)
  132. LSTag (class) (21/04/2014)
  133. LSTagCloud (class) (14/10/2013)
  134. LSTechArticle (class) (18/02/2014)
  135. LSThing (class) (18/02/2014)
  136. LSTimeline (class) (14/10/2013)
  137. LSTimer (class) (16/10/2013)
  138. LSTracer (class) (09/03/2015)
  139. LSUnitTesting (class) (14/10/2013)
  140. URL (functions) (01/04/2015)
  141. LSUser (class) (09/03/2015)
  142. LSUserMgr (class) (14/10/2013)
  143. LSVaesoli (class) (09/06/2014)
  144. LSVersion (class) (14/10/2013)
  145. LSWebSite (class) (14/10/2013)
  146. LSWidget (class) (14/10/2013)
  147. LSWireTransferForm (class) (14/10/2013)
  148. LSXMLSitemap (class) (14/10/2013)
  149. XML (functions) (01/04/2015)

LSApplication.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0015 on 14-10-2013 12:48:48 (DD-MM-YYYY HH:mm:SS). This documentation is built with Vae Soli! functions and classes!

File Properties

C:\websites\vaesoli.org\www\httpdocs/vaesoli/include/LSApplication.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSApplication.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include68907 bytes03/08/2013 23:27:4826/09/2013 16:46:5624/09/2013 17:49:23

Compliance

Assertions count: 0

Assertions successful: 0

Assertion failures: 0

Early Warning

LSApplication.class.php exceeds 51200 bytes. We suggest this file got broken down in smaller chunks!

LSApplication.class.php contains 1470 lines of code, which exceeds the suggested limit of 1024 lines. We suggest this file got broken down in smaller chunks!

Manifest Constants

LS_APPLICATION_CLASS_PWH: Define "LS" Application (Pat Was Here)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSApplication.errors.inc: Application error codes

LSV.functions.php: Vae Soli! Foundation functions

LSDictionary.class.php: Dictionary class

Classes

LSApplication extends LSMotherNatureThis class is the STARTING class of any Vae Soli! site: it starts by the instantiation of an LSApplication object and then by issuing the Run() command.

Constants
NameTypeDescription
VISIT_LIMIT (int) We keep track of the last 15 pages
Properties
NameVisibilityTypeDescription
$instance public LSApplication Application object instance (only 1 instance permitted)
$oBrowser public LSBrowser The browser object (based on LSBrowser parsing)
$oDictionary public LSDictionary Dictionary object
$oEvaluator public LSEvalPHP PHP Evaluator
$oGeorama public LSGeorama Georama object
$oPage public LSPage Page object
$oSession public LSSession Session object
$oVAE public LSVaesoli Vaesoli consciousness
$oVersion public LSVersion Version object (obsolete)
$szBrowser public string Visitor's browser
$szDomain public string Domain of the application (eg. www.vaesoli.org)
$szGeoramaFile public string The physical filename that holds the georama (whole site structure)
$szPHPVersion public string PHP Version string
$szProtocol public string Request protocol
$szReferer public string Referer of the page (if any) (eg. www.vaesoli.org)
$szRerouteTo public string Page to redirect to
$szRoot public string The root folder of the site (DOCUMENT ROOT)
$szTopDomain public string Principal domain of the application (eg. vaesoli)
$szVaesoliPath public string Path to VaeSoli, relative to current site
Parent Properties (LSMotherNature)
NameType
Cargo NULL
GodStamp string
Shelter NULL
__LS_Consciousness NULL
cargo NULL
fPerf double
fPerfThreshold double
id NULL
oApp NULL
oTracer NULL
szNow NULL
szToday NULL
Methods
  1. __construct(): Class constructor
  2. __destruct(): Class destructor. If LSTracer object retains few traces to be written, these are flushed to the tracing output device.
  3. AjaxRun(): Runs program in Ajax mode
  4. GetMsg(): Get a message from the application dictionary
  5. GetVersion(): Returns the version of Vae Soli!
  6. Init(): Initializes the application object
  7. IsiPhone(): Determines whether the application runs on an iPhone
  8. IsMobileBrowser(): Determines whether the application runs on a mobile device
  9. IsPageInTrip(): Determines whether the page/script is present in the trip
  10. IsPageInVisit(): Determines whether the page/script is present in the visit
  11. IsRobot(): Detects whether we have a robot or not
  12. IsScreen(): Detects whether we have a color screen or not
  13. Run(): Runs the program (this will trigger the whole thing)
  14. SetPageInTrip(): Sets the page/script in the trip
  15. SetPageInVisit(): Sets the page/script in the visit
  16. Trip(): Returns the trip of the current visitor. The trip is a set of pages that have been visited (page, count, time per page), which is stored in the session.
  17. Visit(): Returns the visit of the current visitor. The visit is a set of pages that have been visited during the current session (order is important and only the last 15 pages are tracked)
__construct(): Class constructor

[ back to method list ]

Syntax

__construct( $szRoot,$szGeorama,$szVerb,$MustBuild,$szID,$iCache )

Parameters
NameTypeDescription
$szRoot string Root of the site. Optional.
$szGeorama string Georama of the site. Optional.
$szVerb string Verb to invoke once application successfully initialized. Optional.
$MustBuild boolean true if site must be built if no georama found.
$szID string Application ID. Optional.
$iCache string Cache TTL of the georama. Optional.
Parameters Warning

__construct() uses 6 parameters whereas the suggested limit is 3.

Return

(void)

Example(s)
$szRoot = $_SERVER['DOCUMENT_ROOT'];

require_once( $szRoot . '/vaesoli/include/LSVfc.class.php' );

global $oApp;
global $aPHPVersion;

$aPHPVersion = explode( '.',PHP_VERSION );
$szGeorama = $szRoot . '/../georama/georama.xml';

$oApp = new LSApplication( $szRoot      ,   // Root
                           $szGeorama   ,   // Georama file
                           null         ,   // Verb
                           false        ,   // Build if georama file NOT found
                           null         ,   // Application ID
                           7200 );          // Cache of 2 hours on georama
$oApp->Run();
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

__destruct(): Class destructor. If LSTracer object retains few traces to be written, these are flushed to the tracing output device.

[ back to method list ]

Syntax

__destruct()

Parameters

None

Return

(void)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

AjaxRun(): Runs program in Ajax mode

[ back to method list ]

Syntax

AjaxRun()

Parameters

None

Return

(void)

Example(s)
global $__LS_IsAjax;                                            // Global var
$__LS_IsAjax = true;                                            // Say we need Ajax!
$szRoot = $_SERVER['DOCUMENT_ROOT'];                            // Document root
require_once( $szRoot . '/vaesoli/include/LSVfc.class.php');    // Foundation Classes
global $oApp;                                                   // This makes the application a GLOBAL variable ($GLOBALS['oApp'])
$oApp = new LSApplication( $szRoot,                             // New LSApplication object
                           $szRoot . '/../config/georama.xml' );// Think of placing your georama outside the grip of bad people
$oApp->Run();                                                   // Run the app now
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

GetMsg(): Get a message from the application dictionary

[ back to method list ]

Created: 30/10/2012 13:28

Since version 5.0.0010

Syntax

GetMsg( $szKey,$szDefault )

Parameters
NameTypeDescription
$szKey string Key to search for
$szDefault string Default value (if $szKey not found). Optional.
Return

(string) The message corresponding to $szKey

Example(s)
$szPrevMsg = $oPage->GetMsg( 'Previous' );
$szNextMsg = $oPage->GetMsg( 'Next'     );
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

GetVersion(): Returns the version of Vae Soli!

[ back to method list ]

Syntax

GetVersion( $iType )

Parameters
NameTypeDescription
$iType int Type of return of the version object (LSVersion). A value between 1 and 8:

- 1 = major.minor.revision - datetime
- 2 = major.minor.revision
- 3 = major.minor
- 4 = major
- 5 = minor
- 6 = datetime
- 7 = build
- 8 = release

Any other int value will produce a major.minor.revision - datetime - build - release type string
Return

(string) Version of Vae Soli!

Example(s)
$oMyApp = new LSApplication();

for ( $i = 1;$i <= 8;$i++ )
{
    echo $i,': ',$oMyApp->GetVersion( $i ),"\n";
}

// Will print something like:

// 1: 5.1.0000 - Date: 20130131075900
// 2: 5.1.0000
// 3: 5.1
// 4: 5
// 5: 1
// 6: 20130131075900
// 7: Automatic site generation - LSBooking and LSContentsBookin extensions - oActiveIsland and aIslands properties of LSPage
// 8: beta
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Init(): Initializes the application object

[ back to method list ]

Syntax

Init()

Parameters

None

Return

(int) LS_VAESOLI_SUCCESS_SUCCESS

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

IsiPhone(): Determines whether the application runs on an iPhone

[ back to method list ]

Author

Deprecated / Obsolete

This function will be obsolete as of 31/12/2013!

Warning

This method is marked as obsolete. It can be removed from Vae Soli! at any time after the obsolete date

Remark

Use [c]LSBrowser[/c] class instead.

Syntax

IsiPhone()

Parameters

None

Return

(boolean) true if application runs on an iPhone; false if not.

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsMobileBrowser(), IsiPad(), IsiPod()

IsMobileBrowser(): Determines whether the application runs on a mobile device

[ back to method list ]

Author

Deprecated / Obsolete

This function will be obsolete as of 31/12/2013!

Warning

This method is marked as obsolete. It can be removed from Vae Soli! at any time after the obsolete date

Remark

Use [c]LSBrowser[/c] class instead

Syntax

IsMobileBrowser( $szAgent,$aMobileUserAgents )

Alias

IsMobile(), IsHandheld()

Parameters
NameTypeDescription
$szAgent string User agent string. Optional. null by default.
$aMobileUserAgents array Array of mobile User Agents. Optional. null by default.
Return

(boolean) true if application runs on a mobile device; false if not.

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsiPhone(), IsiPad()

IsPageInTrip(): Determines whether the page/script is present in the trip

[ back to method list ]

Abstract

The trip is the list of pages that were visited by a user during a session (NOT inter-session). In Vae Soli! it is stored as an array in the LSApplication object. It resembles the following structure:

array (size=13)
  '/q/todos.php' =
    array (size=2)
      'count' = int 32
      'duration' = int 235288
      'description' = string 'TODO List de Lato Sensu Management' (length=26)
      'title' = string 'Quitus - TODO List - Lato Sensu Management' (length=31)
  '/q/invoices.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 1135
      'description' = string 'Factures de Lato Sensu Management' (length=25)
      'title' = string 'Quitus - Factures - Lato Sensu Management' (length=30)
  '/help.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 4
      'description' = string 'Cette page renseigne le visiteur sur un ensemble
                              de conventions d'utilisation du site de Lato
                              Sensu Management.' (length=103)
      'title' = string 'Aide - Lato Sensu Management' (length=20)

The WhereHaveYouBeen() method of the LSPage is used in the LSContentsBreadcrumb content island to display a breadcrumb that is merely a reminder of the pages the visitor has navigated to during her session. This is extrapolated from the trip.

Docs

See also the trip filter and the breadcrumb documentation: ,

Syntax

IsPageInTrip( $szScript )

Parameters
NameTypeDescription
$szScript string Script to check Optional. null by default in which case $_SERVER['PHP_SELF'] is considered.
Return

(bool)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInVisit(), SetPageInTrip(), SetPageInVisit(), Trip(), Visit()

IsPageInVisit(): Determines whether the page/script is present in the visit

[ back to method list ]

Abstract

The trip is the list of pages that were visited by a user during a session (NOT inter-session). In Vae Soli! it is stored as an array in the LSApplication object. It resembles the following structure:

array (size=13)
  '/q/todos.php' =
    array (size=2)
      'count' = int 32
      'duration' = int 235288
      'description' = string 'TODO List de Lato Sensu Management' (length=26)
      'title' = string 'Quitus - TODO List - Lato Sensu Management' (length=31)
  '/q/invoices.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 1135
      'description' = string 'Factures de Lato Sensu Management' (length=25)
      'title' = string 'Quitus - Factures - Lato Sensu Management' (length=30)
  '/help.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 4
      'description' = string 'Cette page renseigne le visiteur sur un ensemble
                              de conventions d'utilisation du site de Lato
                              Sensu Management.' (length=103)
      'title' = string 'Aide - Lato Sensu Management' (length=20)

The WhereHaveYouBeen() method of the LSPage is used in the LSContentsBreadcrumb content island to display a breadcrumb that is merely a reminder of the pages the visitor has navigated to during her session. This is extrapolated from the trip.

The visit is the list of pages that were visited by a user during a session (NOT inter-session). It is different from the trip in that the visit stores the last 15 pages that were visited without consideration whether the page is already in the list of pages or not (whereas in the trip pages are stored only once with no count limitation).

Docs

See also the trip filter and the breadcrumb documentation: ,

Syntax

IsPageInVisit( $szScript )

Parameters
NameTypeDescription
$szScript string Script to check Optional. null by default in which case $_SERVER['PHP_SELF'] is considered
Return

(bool)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInTrip(), SetPageInTrip(), SetPageInVisit()

IsRobot(): Detects whether we have a robot or not

[ back to method list ]

Deprecated / Obsolete

This function will be obsolete as of 31/12/2013!

Remark

Use [c]LSBrowser[/c] class instead

Syntax

IsRobot( $szBrowser )

Parameters
NameTypeDescription
$szBrowser string The User Agent to examine
Return

(bool) true if robot; false if not

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

IsScreen(): Detects whether we have a color screen or not

[ back to method list ]

Deprecated / Obsolete

This function will be obsolete as of 31/12/2013!

Warning

This function returns ALWAYS true (remark of 01/02/2013 18:02:13)

Syntax

IsScreen( $szBrowser )

Parameters
NameTypeDescription
$szBrowser string The User Agent to examine
Return

(bool) true if color screen; false if not

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

Run(): Runs the program (this will trigger the whole thing)

[ back to method list ]

Syntax

Run()

Parameters

None

Return

(void)

Example(s)
$szRoot = $_SERVER['DOCUMENT_ROOT'];                            // Document root
require_once( $szRoot . '/vaesoli/include/LSVfc.class.php');    // Foundation Classes
global $oApp;                                                   // This makes the application a GLOBAL variable ($GLOBALS['oApp'])
$oApp = new LSApplication( $szRoot,                             // New LSApplication object
                           $szRoot . '/../config/georama.xml' );// Think of placing your georama outside the grip of bad people
$oApp->Run();                                                   // Run the app now
Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

SetPageInTrip(): Sets the page/script in the trip

[ back to method list ]

Remark

The count is set to [c]0[/c] as well as the overall duration this page was consulted.[br] [c]$_SESSION['trip'][$szScript]['count' ] = 0;[/c][br] [c]$_SESSION['trip'][$szScript]['duration' ] = 0;[/c]

Abstract

The trip is the list of pages that were visited by a user during a session (NOT inter-session). In Vae Soli! it is stored as an array in the LSApplication object. It resembles the following structure:

array (size=13)
  '/q/todos.php' =
    array (size=2)
      'count' = int 32
      'duration' = int 235288
      'description' = string 'TODO List de Lato Sensu Management' (length=26)
      'title' = string 'Quitus - TODO List - Lato Sensu Management' (length=31)
  '/q/invoices.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 1135
      'description' = string 'Factures de Lato Sensu Management' (length=25)
      'title' = string 'Quitus - Factures - Lato Sensu Management' (length=30)
  '/help.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 4
      'description' = string 'Cette page renseigne le visiteur sur un ensemble
                              de conventions d'utilisation du site de Lato
                              Sensu Management.' (length=103)
      'title' = string 'Aide - Lato Sensu Management' (length=20)

The WhereHaveYouBeen() method of the LSPage is used in the LSContentsBreadcrumb content island to display a breadcrumb that is merely a reminder of the pages the visitor has navigated to during her session. This is extrapolated from the trip.

The visit is the list of pages that were visited by a user during a session (NOT inter-session). It is different from the trip in that the visit stores the last 15 pages that were visited without consideration whether the page is already in the list of pages or not (whereas in the trip pages are stored only once with no count limitation).

Docs

See also the trip filter

Syntax

SetPageInTrip( $szScript )

Parameters
NameTypeDescription
$szScript string Script to store in the trip. Optional. null by default in which case $_SERVER['PHP_SELF'] is considered
Return

(bool)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInVisit(), SetPageInTrip(), SetPageInVisit()

SetPageInVisit(): Sets the page/script in the visit

[ back to method list ]

Warning

Visit handling is not ready yet. This function does NOT do anything worth it (24-09-13 09:15:46). Stay tuned for changes and announcements will be made on our site.

Abstract

The trip is the list of pages that were visited by a user during a session (NOT inter-session). In Vae Soli! it is stored as an array in the LSApplication object. It resembles the following structure:

array (size=13)
  '/q/todos.php' =
    array (size=2)
      'count' = int 32
      'duration' = int 235288
      'description' = string 'TODO List de Lato Sensu Management' (length=26)
      'title' = string 'Quitus - TODO List - Lato Sensu Management' (length=31)
  '/q/invoices.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 1135
      'description' = string 'Factures de Lato Sensu Management' (length=25)
      'title' = string 'Quitus - Factures - Lato Sensu Management' (length=30)
  '/help.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 4
      'description' = string 'Cette page renseigne le visiteur sur un ensemble
                              de conventions d'utilisation du site de Lato
                              Sensu Management.' (length=103)
      'title' = string 'Aide - Lato Sensu Management' (length=20)

The WhereHaveYouBeen() method of the LSPage is used in the LSContentsBreadcrumb content island to display a breadcrumb that is merely a reminder of the pages the visitor has navigated to during her session. This is extrapolated from the trip.

The visit is the list of pages that were visited by a user during a session (NOT inter-session). It is different from the trip in that the visit stores the last 15 pages that were visited without consideration whether the page is already in the list of pages or not (whereas in the trip pages are stored only once with no count limitation).

Syntax

SetPageInVisit( $szScript )

Parameters
NameTypeDescription
$szScript string Script to store in the visit. Optional. null by default in which case $_SERVER['PHP_SELF'] is considered
Return

(bool)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInVisit(), SetPageInTrip(), IsPageInVisit()

Trip(): Returns the trip of the current visitor. The trip is a set of pages that have been visited (page, count, time per page), which is stored in the session.

[ back to method list ]

Since version 5.3.xxxx

Author

Abstract

The trip is the list of pages that were visited by a user during a session (NOT inter-session). In Vae Soli! it is stored as an array in the LSApplication object. It resembles the following structure:

array (size=13)
  '/q/todos.php' =
    array (size=2)
      'count' = int 32
      'duration' = int 235288
      'description' = string 'TODO List de Lato Sensu Management' (length=26)
      'title' = string 'Quitus - TODO List - Lato Sensu Management' (length=31)
  '/q/invoices.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 1135
      'description' = string 'Factures de Lato Sensu Management' (length=25)
      'title' = string 'Quitus - Factures - Lato Sensu Management' (length=30)
  '/help.php' =
    array (size=2)
      'count' = int 1
      'duration' = int 4
      'description' = string 'Cette page renseigne le visiteur sur un ensemble
                              de conventions d'utilisation du site de Lato
                              Sensu Management.' (length=103)
      'title' = string 'Aide - Lato Sensu Management' (length=20)

The WhereHaveYouBeen() method of the LSPage is used in the LSContentsBreadcrumb content island to display a breadcrumb that is merely a reminder of the pages the visitor has navigated to during her session. This is extrapolated from the trip.

Docs

See also the trip filter and the breadcrumb documentation: ,

Syntax

Trip()

Parameters

None

Return

(array) The trip array or null if no trip recorded

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInTrip(), IsPageInVisit(), SetPageInTrip(), SetPageInVisit(), Visit()

Visit(): Returns the visit of the current visitor. The visit is a set of pages that have been visited during the current session (order is important and only the last 15 pages are tracked)

[ back to method list ]

Since version 5.6.0000

Author

Abstract

The visit is the list of pages that were visited by a user during a session (NOT inter-session). It is different from the trip in that the visit stores the last 15 pages that were visited without consideration whether the page is already in the list of pages or not (whereas in the trip pages are stored only once with no count limitation).

Docs

See also the trip filter

Syntax

Visit()

Parameters

None

Return

(array) The visit array or null if no visit recorded (but this should b-never be the case)

Unit Testing

WARNING: No Unit Testing found. Please provide assertions with assertion constructs ({*assert ... *}) or with GuideAssert() function calls in exec constructs ({*exec ... *}).

See Also

IsPageInTrip(), IsPageInVisit(), SetPageInTrip(), SetPageInVisit(), Trip()

Précédent Suivant