This commit is contained in:
perploug
2013-09-09 16:31:04 +02:00
6 changed files with 172 additions and 8 deletions

View File

@@ -0,0 +1,157 @@
@ngdoc overview
@name Adding serverside data to a property editor
@description
##Overview
In this tutorial we will add a serverside API controller, which will query a custom table in the umbraco database, and then return the data to a simple angular controller + view.
The end result will be a person-list, populated from a custom table, when clicked it will store the ID of the selected person.
##Setup the database
First thing we need is some data, below is a simple SQL Script for create a `people` table with some random data in. You could also use [http://generatedata.com] for larger amounts of data:
CREATE TABLE people (
id INTEGER NOT NULL IDENTITY(1, 1),
name VARCHAR(255) NULL,
town VARCHAR(255) NULL,
country VARCHAR(100) NULL,
PRIMARY KEY (id)
);
GO
INSERT INTO people(name,town,country) VALUES('Myles A. Pearson','Tailles','United Kingdom');
INSERT INTO people(name,town,country) VALUES('Cora Y. Kelly','Froidchapelle','Latvia');
INSERT INTO people(name,town,country) VALUES('Brooke Baxter','Mogi das Cruzes','Grenada');
INSERT INTO people(name,town,country) VALUES('Illiana T. Strong','Bevel','Bhutan');
INSERT INTO people(name,town,country) VALUES('Kaye Frederick','Rothesay','Turkmenistan');
INSERT INTO people(name,town,country) VALUES('Erasmus Camacho','Sint-Pieters-Kapelle','Saint Vincent and The Grenadines');
INSERT INTO people(name,town,country) VALUES('Aimee Sampson','Hawera','Antigua and Barbuda');
##Setup ApiController routes
Next we need to defined a `ApiController` to expose a server side route which our application will use to fetch the data.
For this, we will create a file at: `/app_code/PersonApiController.cs` It must be in app_code since we want our app to compile it on start, alternatively, you can just add it to a normal .net project and compile into a dll as normal.
In the PersonApiController.cs file, add:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using Umbraco.Web.WebApi;
using Umbraco.Web.Editors;
using Umbraco.Core.Persistence;
namespace My.Controllers
{
[Umbraco.Web.Mvc.PluginController("My")]
public class PersonApiController : UmbracoAuthorizedJsonController
{
//we will add a method here later
}
}
This is a very basic Api controller which inherits from `UmbracoAuthorizedJsonController` this specific class will only return json data, and only to requests which are authorized to access the backoffice
##Setup the GetAll() method
Now that we have a controller, we need to create a method, which can return a collection of people, which our editor will use.
So first of all, we add a `Person` class to the `My.Controllers` namespace:
public class Person
{
public int Id { get; set; }
public string Name { get; set; }
public string Town { get; set; }
public string Country { get; set; }
}
We will use this class to map our table data to an c# class, which we can return as json later.
Now we need the `GetAll()` method which returns a collection of people, insert this inside the PersonApiController class:
public IEnumerable<Person> GetAll()
{
}
Inside the GetAll() method, we now write a bit of code, that connects to the database, creates a query and returns the data, mapped to the `Person` class above:
//get the database
var db = UmbracoContext.Application.DatabaseContext.Database;
//build a query to select everything the people table
var query = new Sql().Select("*").From("people");
//fetch data from DB with the query and map to Person object
return db.Fetch<Person>(query);
We are now done with the server side of things, with the file saved in app_code you can now open the Url: /umbraco/My/PersonApi/GetAll
This will return our json code.
##Create a Person Resource
Now that we have the serverside in place, and a Url to call, we will setup a service to retrieve our data. As an Umbraco specific convention, we call these services a *resource, so we always have an indication what services fetch data from the DB.
Create a new file as `person.resource.js` and add:
//adds the resource to umbraco.resources module:
angular.module('umbraco.resources').factory('personResource',
function($q, $http) {
//the factory object returned
return {
//this cals the Api Controller we setup earlier
getAll: function () {
return $http.get("My/PersonApi/GetAll");
}
};
}
);
This uses the standard angular factory pattern, so we can now inject this into any of our controllers under the name `personResource`.
the getAll method just returns a $http.get call, which handles calling the url, and will return the data when its ready.
##Create the view and controller
We will now finally setup a new view and controller, which follows previous tutorials, so have refer to those for more details:
####the view:
<div ng-controller="My.PersonPickerController">
<ul>
<li ng-repeat="person in people">
<a href ng-click="model.value = person.Name">{{person.Name}}</a>
</li>
</ul>
</div>
####The controller:
angular.module("umbraco")
.controller("My.PersonPickerController", function($scope, personResource){
personResource.getAll().then(function(response){
$scope.people = response.data;
});
});
##The flow
So with all these bits in place, all you need to do is register the property editor in a package.manifest - have a look at the first tutorial in this series. You will need to tell the package to load both your personpicker.controller.js and the person.resource.js file on app start.
With this, the entire flow is:
1. the view renders a list of people with a controller
2. the controller asks the personResource for data
3. the personResource returns a promise and asks the /my/PersonAPI api controller
4. The apicontroller queries the database, which returns the data as strongly typed Person objects
5. the api controller returns those `Person` objects as json to the resource
6. the resource resolve the promise
7. the controller populates the view
Easy huh? - honestly tho, there is a good amount of things to keep track of, but each component is tiny and flexible.
##Wrap-up
The important part of the above is the way you create an `ApiController` call the database for your own data, and finally expose the data to angular as a service using $http.
For simplicity, you could also have skipped the service part, and just called $http directly in your controller, but by having your data in a service, it becomes a reusable resource for your entire application.

View File

@@ -51,7 +51,7 @@ For cases like this, a helper service is available: `imageHelper`. This utillity
So we get the image page from the selected media item, and return it through the callback:
var imagePropVal = imageHelper.getImagePropertyVaue({ imageModel: item, scope: $scope });
var imagePropVal = imageHelper.getImagePropertyValue({ imageModel: item, scope: $scope });
callback(imagePropVal);
Now when we run the markdown editor and click the image button, we are presented with a native umbraco dialog, listing the standard media archive.

View File

@@ -66,6 +66,7 @@ angular.module('umbraco.services')
var service = {
active: false,
mode: "default",
touchDevice: false,
ui: ui,
/**
@@ -142,12 +143,15 @@ angular.module('umbraco.services')
* Hides navigation tree, with a short delay, is cancelled if the user moves the mouse over the tree again
*/
leaveTree: function () {
service.active = false;
if(!service.touchDevice){
service.active = false;
$timeout(function(){
if(!service.active){
service.hideTree();
}
}, 300);
}
},
/**
@@ -379,7 +383,7 @@ angular.module('umbraco.services')
*
* @description
* hides the search pane
*/
*/
hideSearch: function () {
setMode("default-hidesearch");
},
@@ -392,7 +396,7 @@ angular.module('umbraco.services')
* hides any open navigation panes and resets the tree, actions and the currently selected node
*/
hideNavigation: function () {
this.ui.currentSection = "";
this.ui.currentSection = "";
this.ui.actions = [];
this.ui.currentNode = undefined;
setMode("default");

View File

@@ -3,6 +3,8 @@
/* CONTAINS ALL HACKS AND OTHER QUICK-FIXES THAT WE MUST HANDLE BEFORE A RELEASE */
/*wft ms?*/
*{ -ms-touch-action: none;}
.umbracoDialog{
width: auto !Important;

View File

@@ -10,9 +10,11 @@
*/
function MainController($scope, $routeParams, $rootScope, $timeout, $http, $log, notificationsService, userService, navigationService, legacyJsLoader) {
//detect if the current device is touch-enabled
$scope.touchDevice = (true === ("ontouchstart" in window || window.DocumentTouch && document instanceof DocumentTouch));
//detect if the current device is touch-enabled
$scope.touchDevice = ("ontouchstart" in window || window.touch || window.navigator.msMaxTouchPoints===5 || window.DocumentTouch && document instanceof DocumentTouch);
navigationService.touchDevice = $scope.touchDevice;
//the null is important because we do an explicit bool check on this in the view
//the avatar is by default the umbraco logo
$scope.authenticated = null;

View File

@@ -23,7 +23,7 @@ module.exports = function(karma) {
'lib/underscore/underscore.js',
'lib/umbraco/Extensions.js',
'lib/umbraco/Extensions.js',
'lib/yepnope/yepnope.min.js',
'test/config/app.unit.js',
@@ -37,7 +37,6 @@ module.exports = function(karma) {
'src/common/mocks/resources/*.js',
'src/views/**/*.controller.js',
'test/unit/**/*.spec.js',
{pattern: 'lib/umbraco/namespacemanager.js', watched: true, served: true}
],