Client Folder. More...

#include <ClientFolder.h>

Inheritance diagram for Wtx::ClientFolder:

Public Member Functions
	ClientFolder (int uid, const std::string &key, const std::string &name)

	ClientFolder (const std::string &uid, const std::string &key, const std::string &name)

	ClientFolder (const ClientFolder &copy)

bool	isValid () const
	Is Valid. More...

const std::string &	uid () const
	Unique ID. More...

const std::string &	key () const
	Key Value. More...

const std::string &	name () const
	Name Value. More...

std::string	fileParent (const std::string &subFolder="") const
	File Parent. More...

std::string	filePath (const std::string &subFolder="") const
	File Path. More...

std::string	fileFolder (const std::string &subFolder="") const
	File Folder. More...

std::string	fileAbsolutePath (const std::string &subFolder="") const
	File Absolute Path. More...

std::string	fileId () const
	Field ID. More...

std::string	fileCode () const
	File Code. More...

std::string	fileName () const
	File Name. More...

std::string	fileKey () const
	File Key. More...

std::string	fileChar () const
	File Character. More...

std::string	fileRoot (const std::string &subFolder="") const
	File Root. More...

	ClientFolder (int uid, const std::string &key, const std::string &name)

	ClientFolder (const std::string &uid, const std::string &key, const std::string &name)

	ClientFolder (const ClientFolder &copy)

bool	isValid () const
	Is Valid. More...

const std::string &	uid () const
	Unique ID. More...

const std::string &	key () const
	Key Value. More...

const std::string &	name () const
	Name Value. More...

std::string	fileParent (const std::string &subFolder="") const
	File Parent. More...

std::string	filePath (const std::string &subFolder="") const
	File Path. More...

std::string	fileFolder (const std::string &subFolder="") const
	File Folder. More...

std::string	fileAbsolutePath (const std::string &subFolder="") const
	File Absolute Path. More...

std::string	fileId () const
	Field ID. More...

std::string	fileCode () const
	File Code. More...

std::string	fileName () const
	File Name. More...

std::string	fileKey () const
	File Key. More...

std::string	fileChar () const
	File Character. More...

std::string	fileRoot (const std::string &subFolder="") const
	File Root. More...

Static Public Member Functions
static void	setup (const std::string &rootPath, const std::string &idPrefix, int idLength, char idPadding, const std::string &idSuffix)
	Setup Global Static. More...

static std::string &	rootPath ()
	Root Path. More...

static std::string &	idPrefix ()
	ID Prefix. More...

static int	idLength ()
	ID Length. More...

static std::string &	idSuffix ()
	ID Suffix. More...

static char	idPadding ()
	ID Padding. More...

static std::string	folder (const std::string &base, const std::string &sub)
	Folder. More...

static void	setup (const std::string &rootPath, const std::string &idPrefix, int idLength, char idPadding, const std::string &idSuffix)
	Setup Global Static. More...

static std::string &	rootPath ()
	Root Path. More...

static std::string &	idPrefix ()
	ID Prefix. More...

static int	idLength ()
	ID Length. More...

static std::string &	idSuffix ()
	ID Suffix. More...

static char	idPadding ()
	ID Padding. More...

static std::string	folder (const std::string &base, const std::string &sub)
	Folder. More...

Detailed Description

Client Folder.

This object encapsulates a handful of functions that can be used to manipulate and interact with client folders that are stored on disk somewhere.

What this object does is take some of the elements of the client file and construct some disk-compatible file-name strings. The reason we want these to be disk-compatible is we are going to make a client folder out of these values, and we don't want any funky characters in them.

This object also contains disk-folder manipulation functions for creating and maintaining client folders. Where this can be very useful is on a file-system where users have access to changing the folder names (they shouldn't, but sometimes they do) and these functions will locate client folders that have been renamed for some reason and will help in getting the names set back to what they should be.

The overall objective is to provide for a common disk-compatible client file naming system, that organizes disk-files in a similar manner to the database itself.

Usage Example:: #include <Wtx/Util/ClientFolder.h>
Wtx::ClientFolder clientFolder
(
(int)customerItem.id(), // customerItem ID
m_customerItem-> keyField().value(), // keyField (abbreviation)
m_customerItem-> cfyField().value() // cfyField (full name)
);

The result of constructing this object with the values above facilitates extracting the various folder properties, such as the root portion of the file path, and the various elements that make it all up.

         +-------------------------------------------------: fileParent()       // includes the 'S' of the folder
         |                        +------------------------: filePath()         // just the part beginning with 'S'
/--------^-------\                |
|                /----------------^------------------\
|                |                +------------------------: fileFolder()       // just the folder part after the 'S'
|                |                |           +------------: fileCode()         // the ID/Code with Prefix and Suffix
|                |                |           |
|                |                |    /------^------\
|                ^ /--------------^------------------\
approot/customer/S/STAY (STAY HERE INC) ~~ C0002876 ~~  <--: fileAbsolutePath() // the whole path
\-------v------/ v \-v-/ \-----v-----/ \-v-/\--v--/\v/
        |        |   |         |         |     |    |
        |        |   |         |         |     |    +------: idSuffix()         // thing to put after the ID
        |        |   |         |         |     +-----------: fileId()           // just the ID with the prefix and prepend
        |        |   |         |         +-----------------: idPrefix()         // prefix-separator
        |        |   |         +---------------------------: fileName()         // the 'full-client-name' of the file
        |        |   +-------------------------------------: fileKey()          // the 'abbreviated-client-name' of the file
        |        +-----------------------------------------: fileChar()         // the first letter of the abbreviation
        +--------------------------------------------------: fileRoot()         // the root path

A Practical Example: 322 Wtx::ClientFolder clientFolder
323 (
324 (int)m_customerItem.id(), // customerItem ID
325 m_customerItem-> keyField().value(), // keyField (abbreviation)
326 m_customerItem-> cfyField().value() // cfyField (full name)
327 );
328
329 std::cout << __FILE__ << ":" << __LINE__ << " "
330 << "\n rootPath:" << clientFolder.rootPath()
331 << "\n idPrefix:" << clientFolder.idPrefix()
332 << "\n idLength:" << clientFolder.idLength()
333 << "\n idSuffix:" << clientFolder.idSuffix()
334 << "\n idPadding:" << clientFolder.idPadding()
335 << "\n isValid:" << clientFolder.isValid()
336 << "\n uid:" << clientFolder.uid()
337 << "\n key:" << clientFolder.key()
338 << "\n name:" << clientFolder.name()
339 << "\n fileParent:" << clientFolder.fileParent()
340 << "\n filePath:" << clientFolder.filePath()
341 << "\n fileFolder:" << clientFolder.fileFolder()
342 << "\n fileAbsolutePath:" << clientFolder.fileAbsolutePath()
343 << "\n fileAbsolutePath:" << clientFolder.fileAbsolutePath("invoices")
344 << "\n fileId:" << clientFolder.fileId()
345 << "\n fileCode:" << clientFolder.fileCode()
346 << "\n fileKey:" << clientFolder.fileKey()
347 << "\n fileChar:" << clientFolder.fileChar()
348 << "\n fileRoot:" << clientFolder.fileRoot()
349 << std::endl;
Produces the following output:
~/projects/clients/CLIENT/warehouse/src/Company/ManagerWidget.cpp:329
rootPath:approot/clients
idPrefix: ~~ C
idLength:6
idSuffix: ~~
idPadding:0
isValid:1
uid:5
key:AIC
name:AMERICAN INTEROPERATIVE CHAINLINK
fileParent:approot/clients/A
filePath:A/AIC (AMERICAN INTEROPERATIVE CHAINLINK) ~~ C000005 ~~
fileFolder:AIC (AMERICAN INTEROPERATIVE CHAINLINK) ~~ C000005 ~~
fileAbsolutePath:approot/clients/A/AIC (AMERICAN INTEROPERATIVE CHAINLINK) ~~ C000005 ~~
fileAbsolutePath:approot/clients/A/AIC (AMERICAN INTEROPERATIVE CHAINLINK) ~~ C000005 ~~/invoices
fileId:000005
fileCode: ~~ C000005 ~~
fileKey:AIC
fileChar:A
fileRoot:approot/clients

Note: This object employs real simple (aka; dumb) string manipulation to generate path strings. Pay attention to NOT sending extra '/' characters as part of the object initialization.

This object encapsulates a handful of functions that can be used to manipulate and interact with client folders that are stored on disk somewhere.

What this object does is take some of the elements of the client file and construct some disk-compatible file-name strings. The reason we want these to be disk-compatible is we are going to make a client folder out of these values, and we don't want any funky characters in them.

This object also contains disk-folder manipulation functions for creating and maintaining client folders. Where this can be very useful is on a file-system where users have access to changing the folder names (they shouldn't, but sometimes they do) and these functions will locate client folders that have been renamed for some reason and will help in getting the names set back to what they should be.

The overall objective is to provide for a common disk-compatible client file naming system, that organizes disk-files in a similar manner to the database itself.

Usage Example:: #include <Wtx/Util/ClientFolder.h>
Wtx::ClientFolder clientFolder
(
(int)customerItem.id(), // customerItem ID
m_customerItem-> keyField().value(), // keyField (abbreviation)
m_customerItem-> cfyField().value() // cfyField (full name)
);

The result of constructing this object with the values above facilitates extracting the various folder properties, such as the root portion of the file path, and the various elements that make it all up.

         +-------------------------------------------------: fileParent()       // includes the 'S' of the folder
         |                        +------------------------: filePath()         // just the part beginning with 'S'
/--------^-------\                |
|                /----------------^------------------\
|                |                +------------------------: fileFolder()       // just the folder part after the 'S'
|                |                |           +------------: fileCode()         // the ID/Code with Prefix and Suffix
|                |                |           |
|                |                |    /------^------\
|                ^ /--------------^------------------\
approot/customer/S/STAY (STAY WELL INC) ~~ C0002876 ~~  <--: fileAbsolutePath() // the whole path
\-------v------/ v \-v-/ \-----v-----/ \-v-/\--v--/\v/
        |        |   |         |         |     |    |
        |        |   |         |         |     |    +------: idSuffix()         // thing to put after the ID
        |        |   |         |         |     +-----------: fileId()           // just the ID with the prefix and prepend
        |        |   |         |         +-----------------: idPrefix()         // prefix-separator
        |        |   |         +---------------------------: fileName()         // the 'full-client-name' of the file
        |        |   +-------------------------------------: fileKey()          // the 'abbreviated-client-name' of the file
        |        +-----------------------------------------: fileChar()         // the first letter of the abbreviation
        +--------------------------------------------------: fileRoot()         // the root path

A Practical Example: 322 Wtx::ClientFolder clientFolder
323 (
324 (int)m_customerItem.id(), // customerItem ID
325 m_customerItem-> keyField().value(), // keyField (abbreviation)
326 m_customerItem-> cfyField().value() // cfyField (full name)
327 );
328
329 std::cout << __FILE__ << ":" << __LINE__ << " "
330 << "\n rootPath:" << clientFolder.rootPath()
331 << "\n idPrefix:" << clientFolder.idPrefix()
332 << "\n idLength:" << clientFolder.idLength()
333 << "\n idSuffix:" << clientFolder.idSuffix()
334 << "\n idPadding:" << clientFolder.idPadding()
335 << "\n isValid:" << clientFolder.isValid()
336 << "\n uid:" << clientFolder.uid()
337 << "\n key:" << clientFolder.key()
338 << "\n name:" << clientFolder.name()
339 << "\n fileParent:" << clientFolder.fileParent()
340 << "\n filePath:" << clientFolder.filePath()
341 << "\n fileFolder:" << clientFolder.fileFolder()
342 << "\n fileAbsolutePath:" << clientFolder.fileAbsolutePath()
343 << "\n fileAbsolutePath:" << clientFolder.fileAbsolutePath("invoices")
344 << "\n fileId:" << clientFolder.fileId()
345 << "\n fileCode:" << clientFolder.fileCode()
346 << "\n fileKey:" << clientFolder.fileKey()
347 << "\n fileChar:" << clientFolder.fileChar()
348 << "\n fileRoot:" << clientFolder.fileRoot()
349 << std::endl;
Produces the following output:
/home/mark/projects/clients/ABC/warehouse/src/Company/ManagerWidget.cpp:329
rootPath:approot/clients
idPrefix: ~~ C
idLength:6
idSuffix: ~~
idPadding:0
isValid:1
uid:5
key:AIC
name:AMERICAN INTERNATIONAL CHEMICAL
fileParent:approot/clients/A
filePath:A/AIC (AMERICAN INTERNATIONAL CHEMICAL) ~~ C000005 ~~
fileFolder:AIC (AMERICAN INTERNATIONAL CHEMICAL) ~~ C000005 ~~
fileAbsolutePath:approot/clients/A/AIC (AMERICAN INTERNATIONAL CHEMICAL) ~~ C000005 ~~
fileAbsolutePath:approot/clients/A/AIC (AMERICAN INTERNATIONAL CHEMICAL) ~~ C000005 ~~/invoices
fileId:000005
fileCode: ~~ C000005 ~~
fileKey:AIC
fileChar:A
fileRoot:approot/clients

Note: This object employs real simple (aka; dumb) string manipulation to generate path strings. Pay attention to NOT sending extra '/' characters as part of the object initialization.

Definition at line 228 of file ClientFolder.h.

Member Function Documentation

std::string Wtx::ClientFolder::fileAbsolutePath ( const std::string & subFolder = "" ) const

File Absolute Path.

This is the client folder absolute path. This includes everything up to the end of the folder (without the appended '/' forward slash. As a matter of convenience a subFolder parameter can be provided, and it will be appended with a '/' slash-separator

std::string Wtx::ClientFolder::fileAbsolutePath ( const std::string & subFolder = "" ) const

File Absolute Path.

This is the client folder absolute path. This includes everything up to the end of the folder (without the appended '/' forward slash. As a matter of convenience a subFolder parameter can be provided, and it will be appended with a '/' slash-separator

Definition at line 300 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileChar ( ) const

File Character.

This is the File single-letter character

std::string Wtx::ClientFolder::fileChar ( ) const

File Character.

This is the File single-letter character

Definition at line 382 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileCode ( ) const

File Code.

This is the portion of the client folder that contains the prefix formatted ID and suffix.

std::string Wtx::ClientFolder::fileCode ( ) const

File Code.

This is the portion of the client folder that contains the prefix formatted ID and suffix.

Definition at line 338 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileFolder ( const std::string & subFolder = "" ) const

File Folder.

This is the portion of the folder that is ~only~ the elements that include only the client info. This does not include the single-character group folder.

std::string Wtx::ClientFolder::fileFolder ( const std::string & subFolder = "" ) const

File Folder.

This is the portion of the folder that is ~only~ the elements that include only the client info. This does not include the single-character group folder.

Definition at line 275 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileId ( ) const

Field ID.

The Formatted File ID

std::string Wtx::ClientFolder::fileId ( ) const

Field ID.

The Formatted File ID

Definition at line 320 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileKey ( ) const

File Key.

This is the reformatted File Key.

std::string Wtx::ClientFolder::fileKey ( ) const

File Key.

This is the reformatted File Key.

Definition at line 371 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileName ( ) const

File Name.

This is the reformatted File Name.

std::string Wtx::ClientFolder::fileName ( ) const

File Name.

This is the reformatted File Name.

Definition at line 360 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileParent ( const std::string & subFolder = "" ) const

File Parent.

This is the parent portion of the folder path. This value includes the single-letter value that identifies the root element to where the client folder is going to exist. It is possible to provide a sub-folder element to this call and it will be appended to the return value as a convenience feature.

std::string Wtx::ClientFolder::fileParent ( const std::string & subFolder = "" ) const

File Parent.

This is the parent portion of the folder path. This value includes the single-letter value that identifies the root element to where the client folder is going to exist. It is possible to provide a sub-folder element to this call and it will be appended to the return value as a convenience feature.

Definition at line 229 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::filePath ( const std::string & subFolder = "" ) const

File Path.

This is the client sub folder element of the client folder. This value also includes the single-character group folder.

std::string Wtx::ClientFolder::filePath ( const std::string & subFolder = "" ) const

File Path.

This is the client sub folder element of the client folder. This value also includes the single-character group folder.

Definition at line 252 of file ClientFolder.cpp.

std::string Wtx::ClientFolder::fileRoot ( const std::string & subFolder = "" ) const

File Root.

This is the root folder. This allows for a sub-folder to be passed in, and this function will insure it is appended properly.

std::string Wtx::ClientFolder::fileRoot ( const std::string & subFolder = "" ) const

File Root.

This is the root folder. This allows for a sub-folder to be passed in, and this function will insure it is appended properly.

Definition at line 393 of file ClientFolder.cpp.

static std::string Wtx::ClientFolder::folder	(	const std::string &	base,
		const std::string &	sub
	)

static

Folder.

This is an internal function that is used to append one string to another with the '/' delimiter.

std::string Wtx::ClientFolder::folder	(	const std::string &	base,
		const std::string &	sub
	)

static

Folder.

This is an internal function that is used to append one string to another with the '/' delimiter.

Definition at line 115 of file ClientFolder.cpp.

static int Wtx::ClientFolder::idLength ( )

static

ID Length.

This determines how many characters the ID value should occupy. When the resulting ID value is short, it is padded to reach this length.

int Wtx::ClientFolder::idLength ( )

static

ID Length.

This determines how many characters the ID value should occupy. When the resulting ID value is short, it is padded to reach this length.

Definition at line 151 of file ClientFolder.cpp.

static char Wtx::ClientFolder::idPadding ( )

static

ID Padding.

This is the single-character that is used to pad the ID value when it is shorted than the idLength().

char Wtx::ClientFolder::idPadding ( )

static

ID Padding.

This is the single-character that is used to pad the ID value when it is shorted than the idLength().

Definition at line 162 of file ClientFolder.cpp.

static std::string& Wtx::ClientFolder::idPrefix ( )

static

ID Prefix.

This string value is placed in the front of the ID string.

std::string & Wtx::ClientFolder::idPrefix ( )

static

ID Prefix.

This string value is placed in the front of the ID string.

Definition at line 140 of file ClientFolder.cpp.

static std::string& Wtx::ClientFolder::idSuffix ( )

static

ID Suffix.

This string value is placed immediately after the ID string.

std::string & Wtx::ClientFolder::idSuffix ( )

static

ID Suffix.

This string value is placed immediately after the ID string.

Definition at line 173 of file ClientFolder.cpp.

bool Wtx::ClientFolder::isValid ( ) const

Is Valid.

This indicates .true. when the object has been properly initialized by the proper constructor.

bool Wtx::ClientFolder::isValid ( ) const

Is Valid.

This indicates .true. when the object has been properly initialized by the proper constructor.

Definition at line 185 of file ClientFolder.cpp.

const std::string& Wtx::ClientFolder::key ( ) const

Key Value.

This is the original KEY value that was provided by the caller.

const std::string & Wtx::ClientFolder::key ( ) const

Key Value.

This is the original KEY value that was provided by the caller.

Definition at line 207 of file ClientFolder.cpp.

const std::string& Wtx::ClientFolder::name ( ) const

Name Value.

This is the orignial NAME value that was provided by the caller.

const std::string & Wtx::ClientFolder::name ( ) const

Name Value.

This is the orignial NAME value that was provided by the caller.

Definition at line 218 of file ClientFolder.cpp.

static std::string& Wtx::ClientFolder::rootPath ( )

static

Root Path.

This returns the static value to the root path of the file system.

Note: This value should ~not~ end with the forward slash '/'

std::string & Wtx::ClientFolder::rootPath ( )

static

Root Path.

This returns the static value to the root path of the file system.

Note: This value should ~not~ end with the forward slash '/'

Definition at line 129 of file ClientFolder.cpp.

static void Wtx::ClientFolder::setup	(	const std::string &	rootPath,
		const std::string &	idPrefix,
		int	idLength,
		char	idPadding,
		const std::string &	idSuffix
	)

static

Setup Global Static.

This functions sets up the global settings for this object. This function should be called at the start of program launch, perhaps in the main() function. Once set, these values will be used by all instances of the object.

Initialization example - tests for folder availability: 36 //
37 // This is the location of the client file folders. This location is intended to
38 // be a smb:mount to the remote server where the files are being stored. If
39 // at any time this mount becomes disconnected, the application should
40 // detect this condition and warn the user.
41 //
43 #define CLIENT_FOLDERS "/mnt/client/warehouse/remoteserver/ClientFiles"
44 #define CLIENT_FOLDERS_FALLBACK "approot/clients"
45
3965 if( Wtx::fileExists( CLIENT_FOLDERS ) )
3966 {
3967 Wtx::ClientFolder::setup
3968 (
3969 CLIENT_FOLDERS, // set value
3970 Wtx::ClientFolder::idPrefix(), // keep default
3971 Wtx::ClientFolder::idLength(), // keep default
3972 Wtx::ClientFolder::idPadding(), // keep default
3973 Wtx::ClientFolder::idSuffix() // keep default
3974 );
3975 }
3976 else
3977 {
3978 layout-> addWidget
3979 (
3980 std::make_unique<Wt::WText>
3981 (
3982 Wt::WString::tr("Warehouse.client-folders-do-not-exist")
3983 .arg(CLIENT_FOLDERS)
3984 )
3985 );
3986
3987 Wtx::ClientFolder::setup
3988 (
3989 CLIENT_FOLDERS_FALLBACK,
3990 Wtx::ClientFolder::idPrefix(),
3991 Wtx::ClientFolder::idLength(),
3992 Wtx::ClientFolder::idPadding(),
3993 Wtx::ClientFolder::idSuffix()
3994 );
3995 }
3996

Parameters

rootPath	Base Path to the point where client char folders will be created. This path should ~not~ end with a '/' (forward slash) character... the folder separator '/' gets added as needed as the object is called upon. Remember that this object uses real simple string manipulation, and does not search for things like '//' in the middle of the string, so pay attention to what's being sent to the rootPath.
idPrefix	String of characters that are prepended to the client 'ID' value. This setting helps force a fixed-known set of characters that appear immediately in front of the ID value such that in the event that the folder is accidently renamed that it can be relocated. The flip side of this issue is if the client itself is renamed, then any client folders that were previously created need to be renamed to match. By providing an ID-Prefix to the file name, it becomes possible to scan the client folders for the encoded ID value, and rename the folder to properly match what's in the database.
idLength	It is possible to control the overall length of the client ID that is represented on the disk folder. This value, used in conjunction with the 'padding' value causes the ID to be padded and filled to match this length.
idPadding	This is a single padding character that is used to fill ID numbers.
idSuffix	This value follows the ID value. The combination of idPrefix() and the idSuffix() improves the ability to identify disconnected and misnamed file folders.

void Wtx::ClientFolder::setup	(	const std::string &	rootPath,
		const std::string &	idPrefix,
		int	idLength,
		char	idPadding,
		const std::string &	idSuffix
	)

static

Setup Global Static.

This functions sets up the global settings for this object. This function should be called at the start of program launch, perhaps in the main() function. Once set, these values will be used by all instances of the object.

Initialization example - tests for folder availability: 36 //
37 // This is the location of the client file folders. This location is intended to
38 // be a smb:mount to the remote server where the files are being stored. If
39 // at any time this mount becomes disconnected, the application should
40 // detect this condition and warn the user.
41 //
43 #define CLIENT_FOLDERS "/mnt/client/warehouse/remoteserver/ClientFiles"
44 #define CLIENT_FOLDERS_FALLBACK "approot/clients"
45
3965 if( Wtx::fileExists( CLIENT_FOLDERS ) )
3966 {
3967 Wtx::ClientFolder::setup
3968 (
3969 CLIENT_FOLDERS, // set value
3970 Wtx::ClientFolder::idPrefix(), // keep default
3971 Wtx::ClientFolder::idLength(), // keep default
3972 Wtx::ClientFolder::idPadding(), // keep default
3973 Wtx::ClientFolder::idSuffix() // keep default
3974 );
3975 }
3976 else
3977 {
3978 layout-> addWidget
3979 (
3980 std::make_unique<Wt::WText>
3981 (
3982 Wt::WString::tr("Warehouse.client-folders-do-not-exist")
3983 .arg(CLIENT_FOLDERS)
3984 )
3985 );
3986
3987 Wtx::ClientFolder::setup
3988 (
3989 CLIENT_FOLDERS_FALLBACK,
3990 Wtx::ClientFolder::idPrefix(),
3991 Wtx::ClientFolder::idLength(),
3992 Wtx::ClientFolder::idPadding(),
3993 Wtx::ClientFolder::idSuffix()
3994 );
3995 }
3996

Parameters

rootPath	Base Path to the point where client char folders will be created. This path should ~not~ end with a '/' (forward slash) character... the folder separator '/' gets added as needed as the object is called upon. Remember that this object uses real simple string manipulation, and does not search for things like '//' in the middle of the string, so pay attention to what's being sent to the rootPath.
idPrefix	String of characters that are prepended to the client 'ID' value. This setting helps force a fixed-known set of characters that appear immediately in front of the ID value such that in the event that the folder is accidently renamed that it can be relocated. The flip side of this issue is if the client itself is renamed, then any client folders that were previously created need to be renamed to match. By providing an ID-Prefix to the file name, it becomes possible to scan the client folders for the encoded ID value, and rename the folder to properly match what's in the database.
idLength	It is possible to control the overall length of the client ID that is represented on the disk folder. This value, used in conjunction with the 'padding' value causes the ID to be padded and filled to match this length.
idPadding	This is a single padding character that is used to fill ID numbers.
idSuffix	This value follows the ID value. The combination of idPrefix() and the idSuffix() improves the ability to identify disconnected and misnamed file folders.

Definition at line 89 of file ClientFolder.cpp.

const std::string& Wtx::ClientFolder::uid ( ) const

Unique ID.

This is a string representation of the ID value that was provided by the constructor.

const std::string & Wtx::ClientFolder::uid ( ) const

Unique ID.

This is a string representation of the ID value that was provided by the constructor.

Definition at line 196 of file ClientFolder.cpp.

The documentation for this class was generated from the following files:

src/Wtx/Util/ClientFolder.h
src/Wtx/Util/StaffFolder.h
src/Wtx/Util/ClientFolder.cpp
src/Wtx/Util/StaffFolder.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation