MonoRail/Castle.Monorail.JSONSupport/JSONHelper.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.Monorail.JSONSupport
  16 {
  17         using Castle.MonoRail.Framework.Helpers;
  18         using Newtonsoft.Json;
  19
  20         /// <summary>
  21         /// Provides utilities methods to work with JSON.
  22         /// </summary>
  23         public class JSONHelper : AbstractHelper
  24         {
  25                 /// <summary>
  26                 /// Converts a instance of the model to its JSON representation.
  27                 /// </summary>
  28                 /// <param name="model">The model.</param>
  29                 /// <returns>The JSON representation of the model.</returns>
  30                 /// <example>
  31                 /// You've constructed a car object instance, like this one:
  32                 /// <code>
  33                 /// Car car = new Car();
  34                 ///
  35                 /// car.Wheels = 4;
  36                 /// car.Model = "Cheap";
  37                 /// car.Year = 2007;
  38                 /// </code>
  39                 /// And to transform it to JSON, you must invoke the method passing the instance.
  40                 /// <code>
  41                 /// helper.ToJSON(car)
  42                 /// </code>
  43                 /// Which will generate the JSON string:
  44                 /// <code>
  45                 /// {Wheels=4,Year=2007,Model='Cheap'}
  46                 /// </code>
  47                 /// </example>
  48                 public string ToJSON(object model)
  49                 {
  50                         return JavaScriptConvert.SerializeObject(model);
  51                 }
  52         }
  53 }