Vae Soli! - Framework PHP - Documentation en ligne

Niouzes

< Janvier 2021 >
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

LSAddress.class.php

Generated by The Vae Soli! Documentor: Guide v. 1.3.0018 on 01-04-2015 16:19:56 (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/LSAddress.class.phpC:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSAddress.class.phpapplication/force-downloadC:\websites\vaesoli.org\www\httpdocs\vaesoli\include18639 bytes03/08/2013 23:27:4802/10/2013 16:19:3002/10/2013 16:19:30

Assertions count: 12

Assertions successful: 12

Assertion failures: 0

File type:classes

Purpose:Class that abstracts an address and which is necessary for Vae Soli! to work properly with Sentanaï and Quitus

Author:Pat Y. Boens

Company:
Lato Sensu Management
Rue Bois des Mazuis, 47
5070 Vitrival
Belgium (BE)
http://www.latosensu.be
Vae Soli! : http://www.vaesoli.org

Creation date:14/09/2010 - 14:33

Modification date:02/10/2013 - 16:19

License:http://creativecommons.org/licenses/by-sa/2.0/be/
To obtain detailed information about the license terms, please head to the full license text available in the LSCopyright.php file

Change History:

[ + ]

Manifest Constants

LS_ADDRESS_CLASS_PWH: Define "LS" address class (Pat Was Here)

VAESOLI_PATH: Define the path where Vae Soli! is installed

VAESOLI_PLUGINS: Define the path where plugins are located

Sources required

LSMap.class.php: Map class

LSV.functions.php: Global functions of the framework

Classes

`LSAddress`Class that defines an address

Properties

Name	Visibility	Type	Description
`$oDictionary`	public	string	Dictionary that must be used to render specific labels
`$oMap`	public	LSMap	Map object
`$szCity`	public	string	City
`$szCountry`	public	string	Country code
`$szID`	public	string	Unique ID of the address
`$szLanguage`	public	string	Language used to render the address. `'fr'` by default
`$szMode`	public	string	Mode in which the address must be rendered
`$szStreet`	public	string	Street
`$szStreetNo`	public	string	Street number
`$szTitle`	public	string	Title of the address
`$szZIP`	public	string	ZIP code

Methods

__construct(): Class constructor
__toString(): Allows the class to decide how it will react when it is treated like a string. A call to Render() is performed. (0 - 0)
GetDictionaryTerm(): Get a term from the dictionary (0 - 0)
Render(): Renders the address in 'view' mode (0 - 0)
RenderView(): Renders the address in 'view' mode (0 - 0)

`__construct()`: Class constructor

[ back to method list ]

Syntax

__construct( $szTitle )

Parameters

Name	Type	Description
`$szTitle`	string	Title of the address. Optional. `null` by default

Return

(void)

Example Executed

// In English
$oAddress = new LSAddress( 'Postal Address' );
$oAddress->oDictionary = new LSDictionary( 'en' );
echo ( $x = $oAddress );
echo LSUnitTesting::assert( strstr( $x,'City' )                                 ,
                            'ASSERTION SUCCESS: City label found'               ,
                            'ASSERTION FAILURE: City label NOT found'           ,
                            'GuideAssert' );

// In French
$oAddress = new LSAddress( 'Adresse de livraison' );
echo ( $x = $oAddress );
echo LSUnitTesting::assert( $oAddress instanceof LSAddress                      ,
                            'ASSERTION SUCCESS: object successfully created'    ,
                            'ASSERTION FAILURE: object NOT created'             ,
                            'GuideAssert' );
echo LSUnitTesting::assert( strstr( $x,'Code postal' )                          ,
                            'ASSERTION SUCCESS: ZIPCode label found'            ,
                            'ASSERTION FAILURE: ZIPCode label NOT found'        ,
                            'GuideAssert' );

Postal Address

Street: Postal code: City : Country :

GuideAssert() ... ASSERTION SUCCESS: City label found

Adresse de livraison

Rue: Code postal: Localité : Pays :

GuideAssert() ... ASSERTION SUCCESS: object successfully created

GuideAssert() ... ASSERTION SUCCESS: ZIPCode label found

Unit Testing

3 assertions: 3 successful; 0 failed

`__toString()`: Allows the class to decide how it will react when it is treated like a string. A call to Render() is performed.

[ back to method list ]

Syntax

__toString()

Parameters

None

Return

(string) HTML code that represents the address

Example Executed

$oAddress = new LSAddress( 'Adresse de livraison' );
echo ( $x = $oAddress );

echo LSUnitTesting::assert( $oAddress instanceof LSAddress                      ,
                            'ASSERTION SUCCESS: object successfully created'    ,
                            'ASSERTION FAILURE: object NOT created'             ,
                            'GuideAssert' );

echo LSUnitTesting::assert( strstr( $x,'Code postal' )                          ,
                            'ASSERTION SUCCESS: ZIPCode label found'            ,
                            'ASSERTION FAILURE: ZIPCode label NOT found'        ,
                            'GuideAssert' );
echo LSUnitTesting::assert( strstr( $x,'fieldset.LS_VAESOLI_ADDRESS_FORM_FIELDSET_SUFFIX' ),
                            'ASSERTION SUCCESS: Fieldset found'            ,
                            'ASSERTION FAILURE: Fieldset NOT found'        ,
                            'GuideAssert' );

Adresse de livraison

Rue: Code postal: Localité : Pays :

GuideAssert() ... ASSERTION SUCCESS: object successfully created

GuideAssert() ... ASSERTION SUCCESS: ZIPCode label found

GuideAssert() ... ASSERTION SUCCESS: Fieldset found

Unit Testing

3 assertions: 3 successful; 0 failed

`GetDictionaryTerm()`: Get a term from the dictionary

[ back to method list ]

Syntax

GetDictionaryTerm( $szTerm,$szDefault )

Parameters

Name	Type	Description
`$szTerm`	string	Term to look for in the dictionary (key to message)
`$szDefault`	string	Default value in case `$szTerm` is an unknown key in the dictionary.

Return

(string) Message defined in dictionary or null if message not found.

Example Executed

$oAddress       = new LSAddress();
$szStreet       = $oAddress->GetDictionaryTerm( 'Street'    ,'NOT FOUND' );
$szPostalCode   = $oAddress->GetDictionaryTerm( 'PostalCode','NOT FOUND' );
echo LSUnitTesting::assert( $szStreet === 'NOT FOUND'                                           ,
                            'ASSERTION SUCCESS: Street term NOT found (no dictionary loaded!)'      ,
                            'ASSERTION FAILURE: Street term found (no dictionary loaded!)'  ,
                            'GuideAssert' );
echo LSUnitTesting::assert( $szPostalCode === 'NOT FOUND'               ,
                            'ASSERTION SUCCESS: Postal code NOT term found (no dictionary loaded!)'      ,
                            'ASSERTION FAILURE: Postal code found (no dictionary loaded!)'  ,
                            'GuideAssert' );
$oAddress->oDictionary = new LSDictionary( 'en' );
$szStreet       = $oAddress->GetDictionaryTerm( 'Street'    ,'NOT FOUND' );
$szPostalCode   = $oAddress->GetDictionaryTerm( 'PostalCode','NOT FOUND' );
echo LSUnitTesting::assert( $szStreet != 'NOT FOUND'                    ,
                            'ASSERTION SUCCESS: Street term found'      ,
                            'ASSERTION FAILURE: Street term NOT found'  ,
                            'GuideAssert' );
echo LSUnitTesting::assert( $szPostalCode != 'NOT FOUND'                ,
                            'ASSERTION SUCCESS: Street term found'      ,
                            'ASSERTION FAILURE: Street term NOT found'  ,
                            'GuideAssert' );


GuideAssert() ... ASSERTION SUCCESS: Street term NOT found (no dictionary loaded!)
GuideAssert() ... ASSERTION SUCCESS: Postal code NOT term found (no dictionary loaded!)
GuideAssert() ... ASSERTION SUCCESS: Street term found
GuideAssert() ... ASSERTION SUCCESS: Street term found

Unit Testing

4 assertions: 4 successful; 0 failed

`Render()`: Renders the address in 'view' mode

[ back to method list ]

Remark

This method is like an alias of RenderView

Syntax

Render( $szSuffix )

Parameters

Name	Type	Description
`$szSuffix`	string	Suffix of the address. Optional. `'Suffix'` by default. The suffix is used to distinguish several addresses that must be rendered at once in a form (an invoicing address and a delivery address for example). This helps distinguish the inner IDs.

Return

(string) HTML Address code of the address rendered as a fieldset

Example Executed

$oAddress = new LSAddress();
$szHTML = $oAddress->Render();
echo LSUnitTesting::assert( strstr( $szHTML,'fieldset.LS_VAESOLI_ADDRESS_FORM_FIELDSET_SUFFIX' ),
                            'ASSERTION SUCCESS: Fieldset found'            ,
                            'ASSERTION FAILURE: Fieldset NOT found'        ,
                            'GuideAssert' );


GuideAssert() ... ASSERTION SUCCESS: Fieldset found

Unit Testing

1 assertions: 1 successful; 0 failed

`RenderView()`: Renders the address in 'view' mode

[ back to method list ]

Syntax

RenderView( $szSuffix )

Parameters

Name	Type	Description
`$szSuffix`	string	Suffix of the address. Optional. `'Suffix'` by default. The suffix is used to distinguish several addresses that must be rendered at once in a form (an invoicing address and a delivery address for example). This helps distinguish the inner IDs.

Return

(string) HTML Address code of the address rendered as a fieldset

Example Executed

$oAddress = new LSAddress();
$szHTML = $oAddress->Render();
echo LSUnitTesting::assert( strstr( $szHTML,'fieldset.LS_VAESOLI_ADDRESS_FORM_FIELDSET_SUFFIX' ),
                            'ASSERTION SUCCESS: Fieldset found'            ,
                            'ASSERTION FAILURE: Fieldset NOT found'        ,
                            'GuideAssert' );


GuideAssert() ... ASSERTION SUCCESS: Fieldset found

Unit Testing

1 assertions: 1 successful; 0 failed

Précédent Suivant

D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php:3672:
object(LogicException)[100]
  protected 'message' => string 'Class LSContentsCookieUsage could not be loaded' (length=47)
  private 'string' (Exception) => string '' (length=0)
  protected 'code' => int 0
  protected 'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
  protected 'line' => int 3601
  private 'trace' (Exception) => 
    array (size=16)
      0 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3601
          'function' => string 'spl_autoload' (length=12)
          'args' => 
            array (size=1)
              ...
      1 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3276
          'function' => string 'EmergeIsland' (length=12)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=6)
              ...
      2 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 2770
          'function' => string 'EmergeIslands' (length=13)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=5)
              ...
      3 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php' (length=72)
          'line' => int 3008
          'function' => string 'EmergeArchipelagosFromParent' (length=28)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=3)
              ...
      4 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5928
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSGeorama' (length=9)
          'type' => string '->' (length=2)
          'args' => 
            array (size=2)
              ...
      5 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5940
          'function' => string 'Land' (length=4)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      6 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\template\vaesoli.html' (length=58)
          'line' => int 135
          'function' => string 'EmergeArchipelagos' (length=18)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      7 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6110
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
      8 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 6053
          'function' => string 'XInclude' (length=8)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      9 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5828
          'function' => string 'IncludeTemplate' (length=15)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      10 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 5580
          'function' => string 'UseTemplate' (length=11)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      11 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 3282
          'function' => string 'RenderXML' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      12 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSPage.class.php' (length=69)
          'line' => int 2082
          'function' => string 'StartPage' (length=9)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      13 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSApplication.class.php' (length=76)
          'line' => int 814
          'function' => string 'Render' (length=6)
          'class' => string 'LSPage' (length=6)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      14 => 
        array (size=6)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\master.php' (length=47)
          'line' => int 8
          'function' => string 'Run' (length=3)
          'class' => string 'LSApplication' (length=13)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
              ...
      15 => 
        array (size=4)
          'file' => string 'D:\websites\vaesoli.org\www\httpdocs\documentation\documentation-vaesoli-code-source.php' (length=88)
          'line' => int 1
          'args' => 
            array (size=1)
              ...
          'function' => string 'include' (length=7)
  private 'previous' (Exception) => null
  public 'xdebug_message' => string '<tr><th align='left' bgcolor='#f57900' colspan="5"><span style='background-color: #cc0000; color: #fce94f; font-size: x-large;'>( ! )</span> LogicException: Class LSContentsCookieUsage could not be loaded in D:\websites\vaesoli.org\www\httpdocs\vaesoli\include\LSGeorama.class.php on line <i>3601</i></th></tr>
<tr><th align='left' bgcolor='#e9b96e' colspan='5'>Call Stack</th></tr>
<tr><th align='center' bgcolor='#eeeeec'>#</th><th align='left' bgcolor='#eeeeec'>Time</th><th align='left' bgcolor='#eeeeec'>Mem'... (length=6627)

Documentation framework web (PHP) Vae Soli!

Niouzes

Citation

Attention

Table Of Contents

LSAddress.class.php

File Properties

Compliance

File Header

Manifest Constants

Sources required

Classes

LSAddressClass that defines an address

Properties

Methods

__construct(): Class constructor

Syntax

Parameters

Return

Example Executed

Unit Testing

__toString(): Allows the class to decide how it will react when it is treated like a string. A call to Render() is performed.

Syntax

Parameters

Return

Example Executed

Unit Testing

GetDictionaryTerm(): Get a term from the dictionary

Syntax

Parameters

Return

Example Executed

Unit Testing

Render(): Renders the address in 'view' mode

Remark

Syntax

Parameters

Return

Example Executed

Unit Testing

RenderView(): Renders the address in 'view' mode

Syntax

Parameters

Return

Example Executed

Unit Testing

`LSAddress`Class that defines an address

`__construct()`: Class constructor

`__toString()`: Allows the class to decide how it will react when it is treated like a string. A call to Render() is performed.

`GetDictionaryTerm()`: Get a term from the dictionary

`Render()`: Renders the address in 'view' mode

`RenderView()`: Renders the address in 'view' mode