GRIS_ADDRESS
extends GRIS_CLASS_TEMPLATE
in package
Class for addresses
With this class the address table can be managed.
PHP version 7
Copyright (c) 2012, Holger Heuser
Tags
Table of Contents
- dbtable = 'gris_address'
- The constant for the database table
- settings_group = "address"
- The constant for the settings group
- $classname : object
- The name of the class
- $dbconnection : object
- The database object for managing the connection
- $full_data : array<string|int, mixed>
- The dataset of the resource information
- $i18n : object
- The object for translations
- $id : object
- The current object ID
- $settings : object
- The object for settings
- $state : object
- The object for state
- $xml_data : string
- The data as xml string
- __construct() : mixed
- The class constructor
- debug() : bool
- Output the full dataset without object data (all subobjects are parsed recursively)
- delete_address() : bool
- Deletes an address entry and removes all reference entries
- delete_empty_addresses() : bool
- Deletes empty address entries (no street name and no city)
- get() : array<string|int, mixed>|object|string
- Returns an array of the full data or (if given) only certain attributes (separated by "|" for a subattribute)
- get_flat_data() : array<string|int, mixed>
- Get the data in a flat format. From subarrays only the first entry is merged
- get_flat_data_old() : array<string|int, mixed>
- Get the data in a flat format. From subarrays only the first entry is merged
- get_references() : array<string|int, mixed>
- Get all references of a given address
- id() : int
- Set a new ID or return the current ID if $id is NULL. The numeric value 0 is also set to NULL.
- persist() : bool
- Persist the object data to the database
- pull_json() : string
- Returns the object data as JSON
- pull_xml() : string
- Returns the object data as XML
- push_xml() : bool
- Push an xml into the object (experimental, not finished yet)
- replace_references() : void
- Replace the address in all reference entries
- reset() : bool
- Reset the whole object (ID = NULL, full_data is empty)
- set() : bool
- Set data in the object
- unset_attribute() : bool
- Unsets an attribute
- update() : bool
- Read or update all data from the address table of the db into an array
- initialize() : bool
- Initializes the object by filling the array with data
- array_to_xml() : bool
- Convert an array into an xml representation
- out() : bool
- Preformatted output of the variable (for development)
Constants
dbtable
The constant for the database table
public
mixed
dbtable
= 'gris_address'
settings_group
The constant for the settings group
public
mixed
settings_group
= "address"
Properties
$classname
The name of the class
protected
object
$classname
= NULL
Tags
$dbconnection
The database object for managing the connection
protected
object
$dbconnection
= NULL
Tags
$full_data
The dataset of the resource information
protected
array<string|int, mixed>
$full_data
= array()
Tags
$i18n
The object for translations
protected
object
$i18n
Tags
$id
The current object ID
protected
object
$id
Tags
$settings
The object for settings
protected
object
$settings
= null
Tags
$state
The object for state
protected
object
$state
Tags
$xml_data
The data as xml string
protected
string
$xml_data
= NULL
Tags
Methods
__construct()
The class constructor
public
__construct([string $address_id = NULL ]) : mixed
Parameters
- $address_id : string = NULL
-
The address ID
Initializes the objects
Return values
mixed —debug()
Output the full dataset without object data (all subobjects are parsed recursively)
public
debug() : bool
Return values
bool —true
delete_address()
Deletes an address entry and removes all reference entries
public
delete_address(mixed $address_id) : bool
Parameters
- $address_id : mixed
Return values
bool —Returns true on success and false on error
delete_empty_addresses()
Deletes empty address entries (no street name and no city)
public
delete_empty_addresses() : bool
Return values
bool —Returns true on success and false on error
get()
Returns an array of the full data or (if given) only certain attributes (separated by "|" for a subattribute)
public
get([string $attribute = NULL ]) : array<string|int, mixed>|object|string
Parameters
- $attribute : string = NULL
-
The attributes separated by [parent|child]
Return values
array<string|int, mixed>|object|string —The dataset or NULL
get_flat_data()
Get the data in a flat format. From subarrays only the first entry is merged
public
get_flat_data([bool $hierarchy = false ][, mixed $data = NULL ]) : array<string|int, mixed>
Parameters
- $hierarchy : bool = false
-
Return full flat (standard) or array hierarchy (if true)
- $data : mixed = NULL
-
Use other data than $this->full_data
Return values
array<string|int, mixed> —The flat data
get_flat_data_old()
Get the data in a flat format. From subarrays only the first entry is merged
public
get_flat_data_old([bool $hierarchy = false ][, mixed $data = NULL ]) : array<string|int, mixed>
Parameters
- $hierarchy : bool = false
-
Return full flat (standard) or array hierarchy (if true)
- $data : mixed = NULL
-
Use other data than $this->full_data
Return values
array<string|int, mixed> —The flat data
get_references()
Get all references of a given address
public
get_references(int $id[, bool $ref_count = false ]) : array<string|int, mixed>
Parameters
- $id : int
-
The ID of the address
- $ref_count : bool = false
-
Return only the count of references
Return values
array<string|int, mixed> —The array with all references or false on error
id()
Set a new ID or return the current ID if $id is NULL. The numeric value 0 is also set to NULL.
public
id([string $id = NULL ]) : int
Parameters
- $id : string = NULL
-
The current ID
Return values
int —The ID
persist()
Persist the object data to the database
public
persist([bool $overwrite = false ]) : bool
Parameters
- $overwrite : bool = false
-
Overwrite an existing entry instead of creating a new one
Return values
bool —Returns true for success and false for a database error (which can be found in the error object). Returns -1 (int), if the address already exists.
pull_json()
Returns the object data as JSON
public
pull_json() : string
Return values
string —The json string
pull_xml()
Returns the object data as XML
public
pull_xml([bool $head = false ]) : string
Parameters
- $head : bool = false
-
Return XML with head (as default, just a node is returned)
Return values
string —The xml string
push_xml()
Push an xml into the object (experimental, not finished yet)
public
push_xml(string $xml) : bool
Parameters
- $xml : string
-
The xml with the object data
Return values
bool —true (or false on error)
replace_references()
Replace the address in all reference entries
public
replace_references(int $source_id[, int $replacement_id = NULL ]) : void
Parameters
- $source_id : int
-
The ID of the source address
- $replacement_id : int = NULL
-
The ID of the replacement address
Return values
void —reset()
Reset the whole object (ID = NULL, full_data is empty)
public
reset() : bool
Return values
bool —Returns true
set()
Set data in the object
public
set(array<string|int, mixed> $data[, bool $writethrough = false ][, bool $overwrite = false ]) : bool
Parameters
- $data : array<string|int, mixed>
-
One or more new key/values for the address (data will be merged, same attributes will be overwritten)
- $writethrough : bool = false
-
Write the object to the database immediately
- $overwrite : bool = false
-
Overwrite an existing entry instead of creating a new one
Return values
bool —Returns true for success and false for no data given. Returns -1 (int), if the address already exists.
unset_attribute()
Unsets an attribute
public
unset_attribute(string $attribute) : bool
Parameters
- $attribute : string
-
The attributes
Return values
bool —Returns true
update()
Read or update all data from the address table of the db into an array
public
update([string $address_id = NULL ]) : bool
Parameters
- $address_id : string = NULL
-
The ID of the address (should also work with an int param)
Return values
bool —Returns true for success and false for address not found
initialize()
Initializes the object by filling the array with data
protected
initialize() : bool
Return values
bool —true (or false on error)
array_to_xml()
Convert an array into an xml representation
private
array_to_xml(array<string|int, mixed> $data, Pointer &$xml) : bool
Parameters
- $data : array<string|int, mixed>
-
The array with the data
- $xml : Pointer
-
A pointer to the xml
Return values
bool —true (or NULL if empty)
out()
Preformatted output of the variable (for development)
private
out([mixed $mixed = NULL ]) : bool
Parameters
- $mixed : mixed = NULL
-
The variable
Return values
bool —true