[Snippet] getdoc

[Guest]

Welcome, Guest. Please login or register.
Did you miss your activation email?

1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[Mark]

This snippet gets a specific field (any of these http://modxcms.com/the-document-object.html) for an individual document.

Example call that will return the content of the first document (id 1):

Code:

[[getdoc? &id=1 &field=`content`]]

Snippet code:

Code:

$id = isset($id)? $id: $modx->documentObject['id'];

$field = isset($field)? $field : "pagetitle";

$result = $modx->getDocument($id,$field);

return $result[$field];

[zi]

Very nice little snippet !

Thanks for sharing.

regards,

zi

[banzai]

great useful snippet! thanks!

[rthrash]

Does it get the raw code or the parsed output?

[Mark]

Parsed output.

Sorry folks I copied and pasted the wrong version!

I updated the first post with the correct version!

[davidm]

Thanks Mark for this much needed snippet, I can think of a few uses for it

[rthrash]

Both versions would be useful actually (parsed and raw unparsed).

[luke.stokes]

Slight modification to look for a template variable:

Code:

// Determine the target document, defaulting to self if nothing specified
$id = (!isset($id)) ? $modx->documentObject['id'] : "$id";
// Document field to get
$field = (!isset($field)) ? 'pagetitle' : "$field";

$array = $modx->getDocument($id);
$output = $array[$field] ;
if (!$output) {
    // try to get a template variable
    $TVarray = $modx->getTemplateVar($field, "*", $id);
    $output = $TVarray["value"];
    if (!$output) {
         $output = $array['pagetitle'];
    }
}
return $output;

[dogas]

Great snippet, although for some documents I request I'm getting no output when I request the content, although the "source retrieved from cache" gives me the following:

Code:

<?php die('Unauthorized access.');

. 

Any help would be greatly appreciated.  Thanks.

[luke.stokes]

Hmm... does it work fine without the modification I made? I just put in a quick hack, I didn't do any security testing. It may be that the template variable you're requesting has specific document permissions on it which would cause the getTemplateVar call to fail. I'd try taking a look at the "some documents" to find a pattern and see if you are requesting info from pages that have security on them.

Hope that helps.

[dogas]

I'm using both versions of your code.  Both of which return a blank output.  I think the "unauthorized access" message is because of a caching issue, which I turned off for the test page I am using.

Is there any other way to debug what might be going on?  Does MODx log output anywhere?

[luke.stokes]

Well, there's the "Event log viewer" under the Administration tab and the Audit trail. Are you calling the snippet cached or unchached ([[getDoc]] or [!getDoc!]). I need learn more about the differences between the two, but I've always been told to use [! !] which does not cache.

Sorry I couldn't be more helpful.

[dogas]

Well, I've sort of figured it out.  It seems for me the getdoc function works correctly if the page does not use a tempate that has template variables.  If i try to get a page the is based on a template that has template variables, it spits out a blank page.

Oh well, back to the drawing board.  Thanks again for your help!

[luke.stokes]

Well, you found a pattern, but I don't think that's the problem. All template variables are associated with templates. So in order to use the getDoc to grab a template variable, by definition the page you are looking for has to have a template (with template variables).

I'd look again at your template variables and the document security you have set for them. That would explain the access error you got.