MonoRail/Castle.MonoRail.Framework/Helpers/JSONHelper.cs

   1 // Copyright 2004-2008 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.Framework.Helpers
  16 {
  17         using Services;
  18
  19         /// <summary>
  20         /// Provides utilities methods to work with JSON.
  21         /// </summary>
  22         public class JSONHelper : AbstractHelper
  23         {
  24                 #region Constructors
  25                 /// <summary>
  26                 /// Initializes a new instance of the <see cref="JSONHelper"/> class.
  27                 /// </summary>
  28                 public JSONHelper() { }
  29                 /// <summary>
  30                 /// Initializes a new instance of the <see cref="JSONHelper"/> class.
  31                 /// setting the Controller, Context and ControllerContext.
  32                 /// </summary>
  33                 /// <param name="engineContext">The engine context.</param>
  34                 public JSONHelper(IEngineContext engineContext) : base(engineContext) { }
  35                 #endregion
  36
  37                 /// <summary>
  38                 /// Converts a instance of the model to its JSON representation.
  39                 /// </summary>
  40                 /// <param name="model">The model.</param>
  41                 /// <returns>The JSON representation of the model.</returns>
  42                 /// <example>
  43                 /// Suppose you have a car object instance, like this one:
  44                 /// <code>
  45                 /// Car car = new Car();
  46                 ///
  47                 /// car.Wheels = 4;
  48                 /// car.Model = "Cheap";
  49                 /// car.Year = 2007;
  50                 /// </code>
  51                 /// And to transform it to JSON, you must invoke the method passing the instance.
  52                 /// <code>
  53                 /// $helper.ToJSON(car)
  54                 /// </code>
  55                 /// Which will generate the JSON string:
  56                 /// <code>
  57                 /// {Wheels=4,Year=2007,Model='Cheap'}
  58                 /// </code>
  59                 /// </example>
  60                 public string ToJSON(object model)
  61                 {
  62                         IJSONSerializer serializer = Context.Services.JSONSerializer;
  63
  64                         if (serializer == null)
  65                         {
  66                                 throw new MonoRailException("Attempt to serialize object failed because the serializer is not available");
  67                         }
  68
  69                         return serializer.Serialize(model);
  70                 }
  71         }
  72 }