binarycloud-cvs-commit

[binarycloud-cvs-commit] cvs: r2 /binarycloud/docs/dev R2Classes.txt

[alex <bin...@li...>]

alex		Sat Sep  8 23:57:11 2001 EDT

  Added files:                 
    /r2/binarycloud/docs/dev	R2Classes.txt 
  Log:
  This is the class hierarchy I expect to have once r2 is complete.
  
  

Index: r2/binarycloud/docs/dev/R2Classes.txt
+++ r2/binarycloud/docs/dev/R2Classes.txt
binarycloud/base/
---------------------
init/
	Init
core/
	Auth
	Perm
	Page
	Debug
	Lang
	Request
	Sess
	Err -> PEAR_Error
	
mgr/
	EntityManager
	QueryManager
	TemplateManager
	MessageManager
	EventManager
	PolicyManager
	JSRequestManager
	CSSRequestManager
	validators/
		NoTags
		NoLineBreaks
		NoEntities
		OnlyChars
		OnlyTagList
		Charset
		Date
		Currency
		Decimal
		Integer
		Time
		ZipCode
		PhoneNumber
		EmailAddress
		Password
		Country
		State
		FASTASequence
		.... suggestions here?
	processors/
		Charset
		Regex
		RemoveEntities
		EncodeEntities
		RemoveTags
		AllowOnlyTagList
		Trim
		RemoveLineBreaks
		AddLineBreaks
		AllowOnlyCharList
		FormatDate
		FormatCurrency
		FormatPhoneNumber
		FormatCountry
		FormatState
		.... suggestions here?
bldr/
	FormBuilder
	ListBuilder
	WizardBuilder
	TreeBuilder
	CalendarBuilder
	EmailBuilder
	FaxBuilder
	PDFBuilder	
	PageDefBuilder
	.... suggestions here?
	UIControlBuilder
	uicontrols/
		TextBoxControl
		WindowStatusControl
		PasswordControl
		TextareaControl
		MultiTextBoxControl
		PulldownControl
		SelectBoxControl
		MaskControl
		RadioButtonControl
		CheckBoxControl
		HrefControl
		ImageControl
		DateControl
		CurrencyControl
		ButtonControl
		TextHeaderControl
		OrderedTextHeaderControl
		ImageHeaderControl
		RowControl
		PaginationControl
		SimpleListControl
		.... suggestions here?
lib/
	ClientSniffer
	HTMLMimeMail
	SMTP
	Timer
	XMLUtils
	Webalizer
	Htdig
	LangKeyer
	...
	
utils/
	xml2php
	php2xml
	pk2dir
	processprepend
	installcode
	langkey2string

binarycloud/user/
---------------------
conf/
	Configuration
	Datasources
	Languages
	Operations
	roles/
		GodRole
		AdminRole
		etc
htdocs/
	resources
		images
		js
		css
		edit

lib/
	user-specific proprietary libs

mod/
	example_module
		ExampleModule
		AnotherExampleModule
		tmpl/
		lang/
		qry/
		ent/
		evt/
		msg/
		resources/
tmpl/
	html
	email
	pdf
	ps
	xml
	wml
	etc..



What we don't need in the source tree:
	user/cache
	user/db
	user/lang
	user/roles
	
	
The build tree:
---------------------
lang_code/
	binarycloud/
		core/
		init/
		lib/
		mgr/
		bldr/
	ext/
		pear/
		metabase/
		vagrant/
		etc/
	htdocs/
		resources/
		...
	user/
		cache/
		conf/
			roles/
		db/
			schema/
			before/
			dump/
			qry/
		mod/
		tmpl/
		ent/
		evt/
		msg/

*Note how the build tree contains many more directories, like ent, msg, etc. This is because make will use the naming conventions below to move files from module and other directories into a single location. That means files must not have naming conflicts, etc - but it keeps the source tree, and the installation process simple.

[binarycloud-cvs-commit] cvs: r2 /binarycloud/docs/dev R2Classes.txt

[alex <bin...@li...>]

alex		Sun Sep  9 00:36:47 2001 EDT

  Modified files:              
    /r2/binarycloud/docs/dev	R2Classes.txt 
  Log:
  Added the naming conventions.
  
  
Index: r2/binarycloud/docs/dev/R2Classes.txt
diff -u r2/binarycloud/docs/dev/R2Classes.txt:1.1 r2/binarycloud/docs/dev/R2Classes.txt:1.2
--- r2/binarycloud/docs/dev/R2Classes.txt:1.1	Sat Sep  8 23:57:11 2001
+++ r2/binarycloud/docs/dev/R2Classes.txt	Sun Sep  9 00:36:47 2001
@@ -195,3 +195,37 @@
 		msg/
 
 *Note how the build tree contains many more directories, like ent, msg, etc. This is because make will use the naming conventions below to move files from module and other directories into a single location. That means files must not have naming conflicts, etc - but it keeps the source tree, and the installation process simple.
+
+
+Naming 'special' files for processing by make:
+---------------------
+-Something.ent.xml = entity xml definition
+
+-Something.qry.xml = query xml definition
+
+-Something.form.xml = form xml definition
+
+-Something.list.xml = list xml definition
+
+-Something.wizard.xml = wizard xml definition
+
+-Something.calendar.xml = calendar xml definition
+
+-Something.email.xml = email xml definition
+
+-Something.fax.xml = fax xml definition
+
+-Something.pdf.xml = pdf xml definition
+
+-Something.role.xml = role xml definition
+
+-SomeValidator.php = 'Validator' means this file will be placed in 
+binarycloud/mgr/validators from a module directory.
+
+-SomeProcessor.php = 'Processor' means this file will be placed in binarycloud/mgr/processors from a module directory
+
+-Something.php.xml = this file will be processed from xml to php using default xml2php rules and written out in the same location in the build tree with the extension .php.
+
+-Something.lang.xml will be used by LangKeyer at make-time to key in nagive-language strings into source files.
+
+-Something.lang_code.php (i.e. Something.de.php or Something.en.php) means the file will replace Something.php in same directory when the language code is the same as lang_code. Useful for writing the same module that does different things based on the location/language.