forked from royratcliffe/ActiveResourceKit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
category_n_s_entity_description_07_active_resource_08.html
160 lines (151 loc) · 10.6 KB
/
category_n_s_entity_description_07_active_resource_08.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ActiveResourceKit: NSEntityDescription(ActiveResource) Category Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ActiveResourceKit
 <span id="projectnumber">v1.0 (481.0)</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="category_n_s_entity_description_07_active_resource_08-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NSEntityDescription(ActiveResource) Category Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#import <<a class="el" href="_n_s_entity_description_09_active_resource_8h_source.html">NSEntityDescription+ActiveResource.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a182fb07888813f6f56f50e72e273a24a"><td class="memItemLeft" align="right" valign="top">(NSDictionary *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="category_n_s_entity_description_07_active_resource_08.html#a182fb07888813f6f56f50e72e273a24a">propertiesFromResource:</a></td></tr>
<tr class="memdesc:a182fb07888813f6f56f50e72e273a24a"><td class="mdescLeft"> </td><td class="mdescRight">Derives attributes from a given resource using this entity description's attributes. <a href="#a182fb07888813f6f56f50e72e273a24a"></a><br/></td></tr>
<tr class="memitem:ab8ad9fbc695f384638879a5b2e47aae3"><td class="memItemLeft" align="right" valign="top">(NSDictionary *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="category_n_s_entity_description_07_active_resource_08.html#ab8ad9fbc695f384638879a5b2e47aae3">attributesFromObject:</a></td></tr>
<tr class="memdesc:ab8ad9fbc695f384638879a5b2e47aae3"><td class="mdescLeft"> </td><td class="mdescRight">Answers a dictionary of Active Resource-style attributes derived from the given object. <a href="#ab8ad9fbc695f384638879a5b2e47aae3"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_n_s_entity_description_09_active_resource_8h_source.html#l00029">29</a> of file <a class="el" href="_n_s_entity_description_09_active_resource_8h_source.html">NSEntityDescription+ActiveResource.h</a>.</p>
</div><h2>Member Function Documentation</h2>
<a class="anchor" id="ab8ad9fbc695f384638879a5b2e47aae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSDictionary *) attributesFromObject: </td>
<td></td>
<td class="paramtype">(NSObject *) </td>
<td class="paramname"><em>object</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Answers a dictionary of Active Resource-style attributes derived from the given object. </p>
<p>Performs reverse-date conversions: from <code>NSDate</code> to RFC 3339-formatted strings suitable for Rails applications. The method iterates through all attributes, attributes only, no relationships. The implementation uses Key-Value Coding to access the given object. For date attributes, it converts from <code>NSDate</code> to RFC 3339 date-time strings. The resulting dictionary of attributes keys by Rails-convention attribute names, i.e. underscored keys rather than camel-cased keys. Use the results for Active Resource attributes, not for Core Data attributes. </p>
<p>Definition at line <a class="el" href="_n_s_entity_description_09_active_resource_8m_source.html#l00051">51</a> of file <a class="el" href="_n_s_entity_description_09_active_resource_8m_source.html">NSEntityDescription+ActiveResource.m</a>.</p>
</div>
</div>
<a class="anchor" id="a182fb07888813f6f56f50e72e273a24a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSDictionary *) propertiesFromResource: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_a_r_resource.html">ARResource</a> *) </td>
<td class="paramname"><em>resource</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Derives attributes from a given resource using this entity description's attributes. </p>
<p>Performs date conversions, using the managed object's entity description to discover attributes. This approach makes an important assumption: that your managed-object model represents the Active Resource schema, or at least part of the schema. There is only one difference: naming convention. The Core Data schema uses camel-case; the resource schema uses underscored names. This method does not validate the schema however. It silently ignores resource attributes that do not appear in the managed-object model.</p>
<p>The method does not handle relationships, only attributes. At this point in the class hierarchy, the method cannot resolve relationships. Resolution requires assumptions about how Core Data relations map to Active Resource relations, and vice versa. Typically this occurs by accessing the foreign key for to-one associations or accessing resources at a remove sub-path in the case of to-many associations. Either way, such mapping must assume things about the Core Data and Active Resource idioms and their interaction. </p>
<p>Definition at line <a class="el" href="_n_s_entity_description_09_active_resource_8m_source.html#l00034">34</a> of file <a class="el" href="_n_s_entity_description_09_active_resource_8m_source.html">NSEntityDescription+ActiveResource.m</a>.</p>
</div>
</div>
<hr/>The documentation for this category was generated from the following files:<ul>
<li>ActiveResourceKit/<a class="el" href="_n_s_entity_description_09_active_resource_8h_source.html">NSEntityDescription+ActiveResource.h</a></li>
<li>ActiveResourceKit/<a class="el" href="_n_s_entity_description_09_active_resource_8m_source.html">NSEntityDescription+ActiveResource.m</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>