Created

Embed URL

HTTPS clone URL

SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

PFQueryTableViewController Template

View gist:ba03c1a550f14f88f95d
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
//
// This is the template PFQueryTableViewController subclass file. Use it to customize your own subclass.
//
 
#import <UIKit/UIKit.h>
#import "Parse/Parse.h"
 
@interface MyPFQueryTableViewController : PFQueryTableViewController
 
@end
 
@implementation MyPFQueryTableViewController
 
- (id)initWithStyle:(UITableViewStyle)style {
self = [super initWithStyle:style];
if (self) {
// Custom the table
// The className to query on
self.className = @"Foo";
// The key of the PFObject to display in the label of the default cell style
self.textKey = @"text";
// Uncomment the following line to specify the key of a PFFile on the PFObject to display in the imageView of the default cell style
// self.imageKey = @"image";
// Whether the built-in pull-to-refresh is enabled
self.pullToRefreshEnabled = YES;
// Whether the built-in pagination is enabled
self.paginationEnabled = YES;
// The number of objects to show per page
self.objectsPerPage = 25;
}
return self;
}
 
- (void)didReceiveMemoryWarning {
// Releases the view if it doesn't have a superview.
[super didReceiveMemoryWarning];
// Release any cached data, images, etc that aren't in use.
}
 
 
#pragma mark - UIViewController
 
- (void)viewDidLoad {
[super viewDidLoad];
// Uncomment the following line to preserve selection between presentations.
// self.clearsSelectionOnViewWillAppear = NO;
// Uncomment the following line to display an Edit button in the navigation bar for this view controller.
// self.navigationItem.rightBarButtonItem = self.editButtonItem;
}
 
- (void)viewDidUnload {
[super viewDidUnload];
// Release any retained subviews of the main view.
// e.g. self.myOutlet = nil;
}
 
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
}
 
- (void)viewDidAppear:(BOOL)animated {
[super viewDidAppear:animated];
}
 
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
}
 
- (void)viewDidDisappear:(BOOL)animated {
[super viewDidDisappear:animated];
}
 
- (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation {
// Return YES for supported orientations
return (interfaceOrientation == UIInterfaceOrientationPortrait);
}
 
 
#pragma mark - PFQueryTableViewController
 
- (void)objectsWillLoad {
[super objectsWillLoad];
// This method is called before a PFQuery is fired to get more objects
}
 
- (void)objectsDidLoad:(NSError *)error {
[super objectsDidLoad:error];
// This method is called every time objects are loaded from Parse via the PFQuery
}
 
/*
// Override to customize what kind of query to perform on the class. The default is to query for
// all objects ordered by createdAt descending.
- (PFQuery *)queryForTable {
PFQuery *query = [PFQuery queryWithClassName:self.className];
// If Pull To Refresh is enabled, query against the network by default.
if (self.pullToRefreshEnabled) {
query.cachePolicy = kPFCachePolicyNetworkOnly;
}
// If no objects are loaded in memory, we look to the cache first to fill the table
// and then subsequently do a query against the network.
if (self.objects.count == 0) {
query.cachePolicy = kPFCachePolicyCacheThenNetwork;
}
[query orderByDescending:@"createdAt"];
return query;
}
*/
 
/*
// Override to customize the look of a cell representing an object. The default is to display
// a UITableViewCellStyleDefault style cell with the label being the textKey in the object,
// and the imageView being the imageKey in the object.
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath object:(PFObject *)object {
static NSString *CellIdentifier = @"Cell";
PFTableViewCell *cell = (PFTableViewCell *)[tableView dequeueReusableCellWithIdentifier:CellIdentifier];
if (cell == nil) {
cell = [[PFTableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier];
}
// Configure the cell
cell.textLabel.text = [object objectForKey:self.textKey];
cell.imageView.file = [object objectForKey:self.imageKey];
return cell;
}
*/
 
/*
// Override if you need to change the ordering of objects in the table.
- (PFObject *)objectAtIndex:(NSIndexPath *)indexPath {
return [self.objects objectAtIndex:indexPath.row];
}
*/
 
/*
// Override to customize the look of the cell that allows the user to load the next page of objects.
// The default implementation is a UITableViewCellStyleDefault cell with simple labels.
- (UITableViewCell *)tableView:(UITableView *)tableView cellForNextPageAtIndexPath:(NSIndexPath *)indexPath {
static NSString *CellIdentifier = @"NextPage";
UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:CellIdentifier];
if (cell == nil) {
cell = [[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier];
}
cell.selectionStyle = UITableViewCellSelectionStyleNone;
cell.textLabel.text = @"Load more...";
return cell;
}
*/
 
#pragma mark - UITableViewDataSource
 
/*
// Override to support conditional editing of the table view.
- (BOOL)tableView:(UITableView *)tableView canEditRowAtIndexPath:(NSIndexPath *)indexPath {
// Return NO if you do not want the specified item to be editable.
return YES;
}
*/
 
/*
// Override to support editing the table view.
- (void)tableView:(UITableView *)tableView commitEditingStyle:(UITableViewCellEditingStyle)editingStyle forRowAtIndexPath:(NSIndexPath *)indexPath {
if (editingStyle == UITableViewCellEditingStyleDelete) {
// Delete the object from Parse and reload the table view
} else if (editingStyle == UITableViewCellEditingStyleInsert) {
// Create a new instance of the appropriate class, and save it to Parse
}
}
*/
 
/*
// Override to support rearranging the table view.
- (void)tableView:(UITableView *)tableView moveRowAtIndexPath:(NSIndexPath *)fromIndexPath toIndexPath:(NSIndexPath *)toIndexPath {
}
*/
 
/*
// Override to support conditional rearranging of the table view.
- (BOOL)tableView:(UITableView *)tableView canMoveRowAtIndexPath:(NSIndexPath *)indexPath {
// Return NO if you do not want the item to be re-orderable.
return YES;
}
*/
 
#pragma mark - UITableViewDelegate
 
- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath {
[super tableView:tableView didSelectRowAtIndexPath:indexPath];
}
 
@end

This may be a little crazy, but I'm overriding initWithCoder in this way to support Storyboard / Interface Builder as opposed to overriding initWithStyle above.

- (id)initWithCoder:(NSCoder *)aDecoder
{
    self = [super initWithClassName:@"Foo"];
    self = [super initWithCoder:aDecoder];
    if (self) {        
        // The className to query on
        self.className = @"Foo";

        // The key of the PFObject to display in the label of the default cell style
        self.keyToDisplay = @"text";

        // Whether the built-in pull-to-refresh is enabled
        self.pullToRefreshEnabled = YES;

        // Whether the built-in pagination is enabled
        self.paginationEnabled = YES;

        // The number of objects to show per page
        self.objectsPerPage = 25;
    }
    return self;
}
Owner

Thanks Jonathan! I'll check it out and then add it to the template if it makes sense. We definitely want to support storyboards.

Jonathan's code worked just fine for me with storyboards so thanks again.

What I would like to share for anyone interested is how to pass the selected object from the PFQueryTableViewController to a DetailViewController since it took me a bit to figure it out. It might not be the greatest way ever but it worked.

First create a property list of type id in the detail controller.

@property (strong, nonatomic) id detailItems; 

Then connect the TableViewCell to the DetailViewController and (assuming you are using a NavigationController) select Push. Select the segue and set the identifier to "whateverYouWant."

In your PFQueryTableViewController you need to implement the prepareForSegue method. Check if the segue being executed is the one with the same identifier. Get the row that was selected and set the detailItems object as follow :


- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender { 
    if ([segue.identifier isEqualToString:@"whateverYouWant"]) {
        DetailViewController *detailViewController = [segue destinationViewController];
        NSInteger row = [[self tableView].indexPathForSelectedRow row];
        detailViewController.detailItems = [self.objects objectAtIndex:row];  
    }
}

This will pass the selected PFObject to the DetailViewController where you can show what you want.

Object keys will be the same column names you defined in your Parse Class. You can print it out to see them in the console if you put the following in the viewDidLoad method in your DetailViewController

NSLog(@"my object contains: %@", self.detailItems);

Hope this helps!

If you change the #pragma marks for the UITableView protocols to what I've got in https://gist.github.com/fe2283fa933d134ce4bd, namely:

#pragma mark - UITableViewDelegate protocol methods

and

#pragma mark - UITableViewDataSource protocol methods

the words UITableViewDataSource and UITableViewDelegate become option-clickable and will take you where those protocols are defined. (Quite handy when you've removed the helper comments but can't remember what other methods will help you customize your tableview.)

Here is one-line way to send the selected object to the detail view controller in your segue:

[[segue destinationViewController] setSelectedObject:[self objectAtIndex:[self.tableView indexPathForCell:sender]]];

You will need to replace the "setSelectedObject" with the name of your actual setter on the detail view controller.

I'm having issues running PFQueryTableViewController on iOS 4.3, unfortunately I'm getting the following crash:

dyld: lazy symbol binding failed: Symbol not found: _objc_retainAutoreleasedReturnValue
Referenced from: /Users/jamiechapman/Library/Application Support/iPhone Simulator/4.3.2/Applications/655CBFAD-E084-4ADB-853C-5B38F3409DDB/X.app/X
Expected in: /Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.3.sdk/System/Library/Frameworks/Foundation.framework/Foundation
dyld: Symbol not found: _objc_retainAutoreleasedReturnValue
Referenced from: /Users/jamiechapman/Library/Application Support/iPhone Simulator/4.3.2/Applications/655CBFAD-E084-4ADB-853C-5B38F3409DDB/X.app/X
Expected in: /Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.3.sdk/System/Library/Frameworks/Foundation.framework/Foundation

I'm assuming this is something to do with ARC (which we're not using)? Any ideas guys?

Owner

Hey Jamie, you'll need to make sure you're running Xcode 4.2+, and if you're targeting iOS 4.3, then make sure to look at step #8 here: https://www.parse.com/apps/quickstart

kent commented

Any word on when Parse will natively support Storyboards? Wondering if I should hack it out, or wait a bit ;)

I am using this current workaround template in my application, and nothing bad has become of it as far as I can tell. The only part that really bothers me is that I like doing things the proper way and sometimes I find myself waking up from dreams where I was trying to figure out a better PFQueryTableViewController Storyboard implementation. It might also be worth pointing out that I didn't have any problem making this work within a UISplitViewController in a Storyboard as well. If you start bringing things like UINavigationControllers into the detail views you will certainly have some fun with Segues but really everything works great regardless. Still, I am eagerly awaiting official Storyboard support and I'm positive I'll at least sleep a little better after that. Good Luck :)

kent commented

I was having some problems getting yours to compile but I will give it another go. Thank you for the comment!

I'm having issues with deleting records - the template throws up errors if i just uncomment that section so I have this at present

// Override to support editing the table view.

  • (void)tableView:(UITableView *)tableView commitEditingStyle:(UITableViewCellEditingStyle)editingStyle forRowAtIndexPath:(NSIndexPath *)indexPath
    {
    [tableView beginUpdates];
    NSInteger row = [[self tableView].indexPathForSelectedRow row];
    [[self.objects objectAtIndex:row] deleteInBackground];

    [tableView deleteRowsAtIndexPaths:[NSArray arrayWithObject:indexPath] withRowAnimation:UITableViewRowAnimationFade];

    [tableView endUpdates];
    [tableView reloadData];
    }

but still get errors Invalid update: invalid number of rows in section 0. The number of rows contained in an existing section after the update (2) must be equal to the number of rows contained in that section before the update (2), plus or minus the number of rows inserted or deleted from that section (0 inserted, 1 deleted) and plus or minus the number of rows moved into or out of that section (0 moved in, 0 moved out).'

Totally stuck hope someone can help!

ashchan commented

@jroes, @jamesyu, @kent: I found another way to support Storylboard without overriding initWithCoder. From the storyboard select the view controller, go to the Identifier inspector, add a User Defined Runtime Attribute: Key Path: 'className', Type: String, Value: your query model class name.

Owner
jamesyu commented

Hey guys, the latest version of our SDK should support storyboard and nibs out of the box! Get it at https://parse.com/docs/downloads

ashchan commented

@crabacus I don't know how the SDK changed for storyboarding, but I'm able to make PFQueryTableViewController work with storyboard as this:

  • from storyboard, add a UITableViewController
  • change the view controller's class to PFQueryTableViewController
  • on Identifier inspector, add a User Defined Runtime Attribute, the key path should be 'className', and the value is the PFObject class you will use (for example, 'Post')
  • now pushing this view controller from navigation controller or other view controller should work.

The problem with PFQueryTableViewController, or many other view controllers from 3rd party libs is they have a init method that requires special parameter. Storyboard seems to only call initWithNibName:bundle: or init. For PFQueryTableViewController, writing our own init or initWithStyle is not helpful, as for some reasons these are not called at all. As @jroes has described, initWithCode: is called, but overriding initWithCode is very strange.

andwang commented

@crabacus, what is the problem you are seeing with using PFQueryTableViewController in storyboard?

andwang commented

@crabacus, send me an email at andrew ( at parse )

andwang commented

@crabacus, thanks for the positive feedback you gave us. Correct me if I am wrong, you are saying PFQueryTableViewController is now working with storyboard fine. That is definitely part of our latest changes to PFQueryTableViewController.

I entirely agree with what you said about PFQueryTableViewController's inheritance from UITableViewController. Your reasoning is also in complete agreement with mine. I have already planned making this change; stay tuned.

I am a fan of Core Data. Right now to use Core Data with Parse leads to a lot of boilerplate code. It is also on my plate to make this simple and straightforward. Again, stay tuned for the upcoming changes.

Cheers!
-Andrew

ilTofa commented

I have a bunch of problems with this code. I upgraded Parse SDK to 1.0.47. Using XCode 4.4.3 (stable). Project uses Storyboards.

1) @jamesyu I'm sorry but my derived class crashes if I use initWithStyle inizialization. Error is:

*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '-[__NSCFDictionary setObject:forKey:]: attempt to insert nil value (key: classname)'

I still use the initWithCoder as in comment 1 (and it still works)

2) self.keyToDisplay is not on class definition anymore (or at least Xcode complains that property is not found).

3) I use to get back to a delegate for processing (I think this is a typical pattern) as in

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
    [super tableView:tableView didSelectRowAtIndexPath:indexPath];
    [self.delegate radioChooserViewControllerDidSelect:self withObject:[self objectAtIndex:indexPath]];
}

This crashes when user clicks on the "load more" cell. This is understandable, I know, but I have no way to know if I'm on a "pagination cell" without doing pagination myself...
Crash is

*** Terminating app due to uncaught exception 'NSRangeException', reason: '*** -[__NSArrayM objectAtIndex:]: index 25 beyond bounds [0 .. 24]

This is for a 25 rows pagination, of course.

Any hint? (3) makes the class unusable for me.

If you are using the PFQueryTableViewController and have pagination enabled then you need to take the pagination cell into account when overriding the tableview didSelectRowAtIndexPath method. Essentially, if you are not on the pagination row handle the touch with your own method, otherwise pass touch to the parent implementation. Something like this should work:

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
    if (indexPath.row < [self.objects count])
    {
        // Your custom row select code here
        [self.delegate radioChooserViewControllerDidSelect:self withObject:[self objectAtIndex:indexPath]];
    } else {
        // This is the pagination cell so let the parent handle it
        [super tableView:tableView didSelectRowAtIndexPath:indexPath];
    }
}

As far as using initWithStyle or initWithCoder, neither of those are really necessary with a Storyboard implementation and in fact initWithStyle will probably lead to problems. In your Storyboard with the PFQueryTableViewController scene selected, look at the Identity Inspector tab and there should be an area for User Defined Runtime Attributes. You can configure the className, objectsPerPage, pullToRefreshEnabled, and paginationEnabled right there (as well as any other needed properties). You can see a screenshot of what I mean right here:

http://crabtree.net/userDefinedRuntimeAttributes.jpg

As for the keyToDisplay property I have never used it but it may not exist anymore as I don't see it in the API. You might try using the textKey property instead. That could also be configured in the user defined runtime attributes in the Storyboard, although I usually just override tableView:cellForRowAtIndexPath:object: and create custom cell views.

Anyway, hopefully some of that will help you out.

ilTofa commented

OK. Thank you... You should edit this gist, btw... for all 3 things. This sample is linked from iOS guide. ;)

Owner

We've updated the gist to fix the issues! Thanks guys!

There are some really helpful comments here, but does anyone have any pointers on getting PFQueryTableViewController working well with sections? I can produce the sections and count the rows, but haven't yet been able to put them together.

Hi, I'm trying to implement a PFQueryTableViewController with storyboards, and I keep getting this error:

2012-07-11 01:31:01.360 ParseStarterProject[35323:f803] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'The nib file did not specify a UITableView as its view of PFQueryTableViewController.'

I've tried to add the "User Defined Runtime Attributes" in Interface Builder, as suggested above. But that hasn't worked.

I'm using Xcode 4.3.2 and I have the latest Parse SDK: v1.0.56 (downloaded this past week).

I've tried creating both a UITableViewController and a UIViewController (as the latest PFQueryTableViewController no longer subclasses UITableViewController by UIViewController instead). But that doesn't work either.

Hi! Is it possible to use this class to control a UITableView (not fullscreen table view dragged from Objects Library to an existing ViewController)?

@davidhlee

I am using storyboard and I got a similar exception saying that the loaded viewcontroller get something that is not UITableViewController. I checked the storyboard and in the Interface Builder I deleted the view under the ViewController (the IB created it in the first time), and It works for me. Guessing it's that view masked the UITableView that comes along with PFQueryTableViewController. Maybe you might also want to check on that.

I'm trying to set the tableviewcell's separate color

self.tableView.separatorStyle = UITableViewCellSeparatorStyleNone; 

but it didn't work.

One thing that needs made easier is the ability to create DetailViewControllers using storyboards and Parse. Currently I have it working but I had to include a lot of extra code that shouldn't be required.

Noob question here.

@crabacus mentioned, "As far as using initWithStyle or initWithCoder, neither of those are really necessary with a Storyboard implementation".

Everything is working fine with initWithCoder but when I remove the init method to use the Storyboard it crashes.

@crabacus also mentions to change the view controller's class to PFQueryTableViewController but in MasterViewController.h I have it sub-classed as so: @interface MasterViewController : PFQueryTableViewController and according to https://parse.com/tutorials/geolocations (section 2) they don't change the custom class in Identity Inspector when it's already set as a sub-class.

Any help much appreciated.

The className property has been changed to parseClassName property.

:+1: @bjackson true that.

- (PFObject *)objectAtIndex:(NSIndexPath *)indexPath

should be

- (PFObject *)objectAtIndexPath:(NSIndexPath *)indexPath

Hello, please update line 20 and 106 from:

    // The className to query on
    self.className = @"Foo";

to:

    // The className to query on
    self.parseClassName = @"Foo";
ericfr commented

talking about efficient code. this is awesome template!

very good help

Hi,
I'm new to Parse and have this request. I want to build tho simple app in which I used Navigation controller ( so that I can go forward and backward from the main view) and has two buttons in the first view that will appear for the user, and each button will take the user to a different view. I dragged and dropped two view controllers, created a class named "CommentsViewController" which is a subclass of PFQueryTableViewController and assigned it to one of the two view controllers. Finally, I press on one button in the main view ctrl+click and drag to that view controller that has the above class assigned to it and clicked on push. Unfortunalty my app crashes when I want to go this view.
Any idea why??

please update line 20 and 106 from:

// The className to query on
self.className = @"Foo";

to:

// The className to query on
self.parseClassName = @"Foo";

Also, about storyboards, try commonInit pattern.

- (void)commonInit
{
    self.parseClassName = @"Foo";
    self.pullToRefreshEnabled = YES;
    self.paginationEnabled = YES;
    self.objectsPerPage = 25;
    self.loadingViewEnabled = NO;
}

- (id)initWithStyle:(UITableViewStyle)style
{
    self = [super initWithStyle:style];
    if (!self) return nil;

    [self commonInit];

    return self;
}

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{
    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
    if (!self) return nil;

    [self commonInit];

    return self;
}

- (id)initWithCoder:(NSCoder *)aDecoder
{
    self = [super initWithCoder:aDecoder];
    if (!self) return nil;

    [self commonInit];

    return self;
}

When deleting in

- (void)tableView:(UITableView *)tableView commitEditingStyle:(UITableViewCellEditingStyle)editingStyle forRowAtIndexPath:(NSIndexPath *)indexPath

I always have to reload the complete data set using [self loadObjects]. This seems wasteful and I'd love to see support to delete/reload single rows such that it can be used in combination with

[tableView deleteRowsAtIndexPaths:@[indexPath] withRowAnimation:UITableViewRowAnimationFade]

Are there plans for (or is there already) a similar sample subclass template file in Swift?

Any idea where I cold find this in SWIFT?

I agree with herveg, we would really appreciate the template written in Swift. Now its more pain than gain ...

zsll commented

Really appreciate it if you can have a swift version of this.

+1 for a modern Swift implementation.

Caraveo commented

What's the best way to reload the TableView and re-run the query programmatically(not using an interface control or gesture)? I think [self.tableView reloadData]; reloads the table view with the original query data not the refreshed data. Please help, Thanks!

EDIT: [self loadObjects];
Seems to do the task. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.