Coding guideline - CatGlobe - Revision history

Phamhuuphucgopenid at 08:17, 8 January 2015

2015-01-08T08:17:09Z

← Older revision		Revision as of 08:17, 8 January 2015
Line 1:		Line 1:
	~~<accesscontrol>Main:MyGroup</accesscontrol>~~
	== Introduction ==		== Introduction ==

Wikicatglobe at 03:56, 18 October 2013

2013-10-18T03:56:33Z

← Older revision		Revision as of 03:56, 18 October 2013
Line 1:		Line 1:
	<accesscontrol>~~Administrators,,Cem,,Maysunshine~~</accesscontrol>		<accesscontrol>Main:MyGroup</accesscontrol>
	== Introduction ==		== Introduction ==

Cg_pham at 09:27, 4 October 2011

2011-10-04T09:27:19Z

← Older revision		Revision as of 09:27, 4 October 2011
Line 1:		Line 1:
			<accesscontrol>Administrators,,Cem,,Maysunshine</accesscontrol>
	== Introduction ==		== Introduction ==

Catglobe at 06:27, 22 December 2008

2008-12-22T06:27:38Z

← Older revision		Revision as of 06:27, 22 December 2008
Line 182:		Line 182:
	*Example:		*Example:

	'''''Wrong:<br>'''''		'''''Wrong:<br>'''''<source lang="csharp" line="1">
	<source lang="csharp" line="1">		StringBuilder sqlBuilder = new StringBuilder();
	StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.Append("SELECT ID"); sqlBuilder.Append(" FROM "); sqlBuilder.Append(" USER_RESOURCE "); sqlBuilder.Append(" WHERE "); sqlBuilder.Append(" NAME "); sqlBuilder.Append(" = "); sqlBuilder.Append(userName); sqlBuilder.Append(" AND "); sqlBuilder.Append(" (Access_Expiration ~~<~~= "); sqlBuilder.Append(CGDateTime.Now.ToString()); sqlBuilder.Append(" OR "); sqlBuilder.Append(" Access_Expiration is NULL) ");		sqlBuilder.Append("SELECT ID");
	</source>		sqlBuilder.Append(" FROM ");
			sqlBuilder.Append(" USER_RESOURCE ");
			sqlBuilder.Append(" WHERE ");
			sqlBuilder.Append(" NAME ");
			sqlBuilder.Append(" = ");
			sqlBuilder.Append(userName);
			sqlBuilder.Append(" AND ");
			sqlBuilder.Append(" (Access_Expiration <= ");
			sqlBuilder.Append(CGDateTime.Now.ToString());
			sqlBuilder.Append(" OR ");
			sqlBuilder.Append(" Access_Expiration is NULL) ");
			</source>

	'''''Correct:<br>'''''		'''''Correct:<br>'''''
	<source lang="csharp" line="1">		<source lang="csharp" line="1">
	StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.AppendFormat("SELECT {0} ", PC.UserResource.Id); sqlBuilder.AppendFormat("FROM {0} ", PC.UserResource.TableName); sqlBuilder.Append("WHERE "); sqlBuilder.AppendFormat("{0} = {1} ", PC.UserResource.ShortName.Name, GetLiteral(userName)); sqlBuilder.AppendFormat("AND ({0} ~~<~~= {1} OR {0} is NULL)", PC.UserResource.AccessExpiration.Name, GetLiteral(CGDateTime.Now));		StringBuilder sqlBuilder = new StringBuilder();
	</source>		sqlBuilder.AppendFormat("SELECT {0} ", PC.UserResource.Id);
	<br>		sqlBuilder.AppendFormat("FROM {0} ", PC.UserResource.TableName);
			sqlBuilder.Append("WHERE ");
			sqlBuilder.AppendFormat("{0} = {1} ", PC.UserResource.ShortName.Name, GetLiteral(userName));
			sqlBuilder.AppendFormat("AND ({0} <= {1} OR {0} is NULL)", PC.UserResource.AccessExpiration.Name, GetLiteral(CGDateTime.Now));
			</source> <br>

	== Performance ==		== Performance ==

Catglobe at 06:26, 22 December 2008

2008-12-22T06:26:47Z

← Older revision		Revision as of 06:26, 22 December 2008
Line 182:		Line 182:
	*Example:		*Example:

	'''''Wrong:<br>'''''~~<~~source lang="csharp" line="1"~~>~~ StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.Append("SELECT ID"); sqlBuilder.Append(" FROM "); sqlBuilder.Append(" USER_RESOURCE "); sqlBuilder.Append(" WHERE "); sqlBuilder.Append(" NAME "); sqlBuilder.Append(" = "); sqlBuilder.Append(userName); sqlBuilder.Append(" AND "); sqlBuilder.Append(" (Access_Expiration <= "); sqlBuilder.Append(CGDateTime.Now.ToString()); sqlBuilder.Append(" OR "); sqlBuilder.Append(" Access_Expiration is NULL) "); ~~</source>~~		'''''Wrong:<br>'''''
			<source lang="csharp" line="1">
	~~'''''Correct:~~<br>'''''<source lang="csharp" line="1"> StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.AppendFormat("SELECT {0} ", PC.UserResource.Id); sqlBuilder.AppendFormat("FROM {0} ", PC.UserResource.TableName); sqlBuilder.Append("WHERE "); sqlBuilder.AppendFormat("{0} = {1} ", PC.UserResource.ShortName.Name, GetLiteral(userName)); sqlBuilder.AppendFormat("AND ({0} <= {1} OR {0} is NULL)", PC.UserResource.AccessExpiration.Name, GetLiteral(CGDateTime.Now)); </source~~>~~		StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.Append("SELECT ID"); sqlBuilder.Append(" FROM "); sqlBuilder.Append(" USER_RESOURCE "); sqlBuilder.Append(" WHERE "); sqlBuilder.Append(" NAME "); sqlBuilder.Append(" = "); sqlBuilder.Append(userName); sqlBuilder.Append(" AND "); sqlBuilder.Append(" (Access_Expiration <= "); sqlBuilder.Append(CGDateTime.Now.ToString()); sqlBuilder.Append(" OR "); sqlBuilder.Append(" Access_Expiration is NULL) ");
			</source>

			'''''Correct:<br>'''''
			<source lang="csharp" line="1">
			StringBuilder sqlBuilder = new StringBuilder(); sqlBuilder.AppendFormat("SELECT {0} ", PC.UserResource.Id); sqlBuilder.AppendFormat("FROM {0} ", PC.UserResource.TableName); sqlBuilder.Append("WHERE "); sqlBuilder.AppendFormat("{0} = {1} ", PC.UserResource.ShortName.Name, GetLiteral(userName)); sqlBuilder.AppendFormat("AND ({0} <= {1} OR {0} is NULL)", PC.UserResource.AccessExpiration.Name, GetLiteral(CGDateTime.Now));
			</source>
	<br>		<br>

Catglobe at 06:26, 22 December 2008

2008-12-22T06:26:00Z

← Older revision		Revision as of 06:26, 22 December 2008
Line 147:		Line 147:
	*The callback method which is used when creating object is named Create. In this method, data is read from the IDataReader to build an object. Signature of the Create method is:		*The callback method which is used when creating object is named Create. In this method, data is read from the IDataReader to build an object. Signature of the Create method is:

	~~<~~source lang="csharp" line="1"~~>~~ static private T Create(ref CreateOrd co, IDataReader reader) ~~<~~/source~~>~~		<source lang="csharp" line="1">
			static private T Create(ref CreateOrd co, IDataReader reader)
			</source>

	where T is a domain class, for example User, Attachment or EmailAddress.		where T is a domain class, for example User, Attachment or EmailAddress.

Catglobe at 06:25, 22 December 2008

2008-12-22T06:25:36Z

← Older revision		Revision as of 06:25, 22 December 2008
Line 156:		Line 156:

	static private void Save(T emailerror, IDataReader reader)		static private void Save(T emailerror, IDataReader reader)
	</source>		</source>

	*Create two delegates for the two methods above. These delegates are passed to the AccessBase.Execute[Action] methods:		*Create two delegates for the two methods above. These delegates are passed to the AccessBase.Execute[Action] methods:

	<source lang="csharp" line="1">		<source lang="csharp" line="1">
	static readonly CreateDelegateGen~~<~~T~~>~~ create = Create;		static readonly CreateDelegateGen<T> create = Create;

	static readonly SaveDelegateGen~~<~~T~~>~~ save = Save;		static readonly SaveDelegateGen<T> save = Save;
	</source>		</source>

Catglobe at 06:25, 22 December 2008

2008-12-22T06:25:19Z

← Older revision		Revision as of 06:25, 22 December 2008
Line 153:		Line 153:
	*The callback method which is used when saving object is named Save. In this method, the primary key of the being saved object is read from the IDataReader and update to the object. If the object is a Resource, version is read and update too. Signature of the Save method is:		*The callback method which is used when saving object is named Save. In this method, the primary key of the being saved object is read from the IDataReader and update to the object. If the object is a Resource, version is read and update too. Signature of the Save method is:

	~~<~~source lang="csharp" line="1"~~>~~		<source lang="csharp" line="1">

	static private void Save(T emailerror, IDataReader reader) ~~<~~/source~~>~~		static private void Save(T emailerror, IDataReader reader)
			</source>

	*Create two delegates for the two methods above. These delegates are passed to the AccessBase.Execute[Action] methods:		*Create two delegates for the two methods above. These delegates are passed to the AccessBase.Execute[Action] methods:

	~~<~~source lang="csharp" line="1"~~>~~ static readonly CreateDelegateGen<T> create = Create;		<source lang="csharp" line="1">
			static readonly CreateDelegateGen<T> create = Create;

	static readonly SaveDelegateGen<T> save = Save; ~~<~~/source~~>~~		static readonly SaveDelegateGen<T> save = Save;
			</source>

	=== Building query ===		=== Building query ===

Catglobe at 04:54, 22 December 2008

2008-12-22T04:54:36Z

@@ Line 414: / Line 414: @@
 == How to create a CGScript library or function  ==
-<br>
+*CGScript functions are in the CatGlobe.Framework.Runtime namespace. You need to specify which library the function belongs to.
 [[Category:Technical_guidelines]]

Catglobe at 04:50, 22 December 2008

2008-12-22T04:50:38Z

@@ Line 383: / Line 383: @@
 == Utility classes  ==
-<br>
+*Classes in the namespace CatGlobe.Framework.Text have many APIs which are used to work with strings:
-<br>
+&nbsp;&nbsp;&nbsp;&nbsp; -&nbsp;Encode strings to use in javascript, in HTML.
 == How to create a CGScript library or function  ==