Placing a Context Setting into a Snippet?

43 Posts

Aaron Brewer Reply #1, 14 years ago

Hello!

How would one come across putting a Context Setting into a Snippet?

Hence:

$variable = $modx-example([[++examplecontextsetting]]);

Thank you!

The web is our sandbox, so let's develop a castle.

483 Posts

Fuzzical Logic Reply #2, 14 years ago

This will get the current Setting in play in the current Context. Understand this: if the currently logged in user has a User Setting of the same key, it will override the Context Setting. If there is no Context Setting of that key, it will check System Settings. If the key doesn't exist in any of those, then it applies the default value.

    $modx->getOption('setting_key', null, 'default');

Which value it gets can be modified by the 2nd argument. For details, see the documentation.

Website: Extended Dialog Development Blog: on Extended Dialog
Add-ons: AJAX Revolution, RO.IDEs Editor & Framework (in works) Utilities: Plugin Compatibility List
Tutorials: Create Cross-Context Resources, Cross-Context AJAX Login, Template-Based Actions, Remove Extensions from URLs

Failure is just another word for saying you didn't want to try. "It can't be done" means "I don't know how".

24,544 Posts

BobRay Reply #3, 14 years ago

If you want to avoid collisions with other settings and get only Context Settings, I think you can use this:

$value = $modx->context->getOption('setting_key', null, 'default');

The default value will be used if the Context Setting doesn't exist.

If you need settings from a particular context that might not be the current context:

$key = 'web'  /* or whatever */
$ctx = $modx->getContext('key');
if ($ctx) {
     $value = $ctx->getOption('setting_key', null, 'default');
} else {
    /* context doesn't exist */
}

------------------------------------------------------------------------------------------
PLEASE, PLEASE specify the version of MODX you are using.
MODX info for everyone: http://bobsguides.com/modx.html [ed. note: BobRay last edited this post 14 years ago.]

Did I help you? Buy me a beer
Get my Book: MODX:The Official Guide
MODX info for everyone: http://bobsguides.com/modx.html
My MODX Extras
Bob's Guides is now hosted at A2 MODX Hosting

43 Posts

Aaron Brewer Reply #4, 14 years ago

Awesome! Thank you BobRay, I will play with this and let you know.

The web is our sandbox, so let's develop a castle.

43 Posts

Aaron Brewer Reply #5, 14 years ago

Thank you Fuzzical Logic, I understand. Thank you very much!

The web is our sandbox, so let's develop a castle.

MODX Staff
10,725 Posts

opengeek Reply #6, 14 years ago

FWIW, you should use getContext() instead of getObject() when working with Contexts. This stores the results in an array of shared Context objects on the modX object for reuse within the request cycle. getObject will always look into the database to retrieve the object.

$key = 'web'  /* or whatever */
$ctx = $modx->getContext($key);
if ($ctx) {
     $value = $ctx->getOption('setting_key', null, 'default');
} else {
    /* context doesn't exist */
}

Jason Coward
Chief Architect @ MODX
http://www.jasoncoward.com | http://twitter.com/drumshaman | https://github.com/opengeek

483 Posts

Fuzzical Logic Reply #7, 14 years ago

@OpenGeek:

Strangely, I've never thought to use getContext() to get ContextSettings... I should have guessed that this could be done, quite easily. Thanks!

Crap! Now, I'm getting even more ideas.... and not all of them are good.

Website: Extended Dialog Development Blog: on Extended Dialog
Add-ons: AJAX Revolution, RO.IDEs Editor & Framework (in works) Utilities: Plugin Compatibility List
Tutorials: Create Cross-Context Resources, Cross-Context AJAX Login, Template-Based Actions, Remove Extensions from URLs

Failure is just another word for saying you didn't want to try. "It can't be done" means "I don't know how".

24,544 Posts

BobRay Reply #8, 14 years ago

Good point. Post fixed above.

------------------------------------------------------------------------------------------
PLEASE, PLEASE specify the version of MODX you are using.
MODX info for everyone: http://bobsguides.com/modx.html

Did I help you? Buy me a beer
Get my Book: MODX:The Official Guide
MODX info for everyone: http://bobsguides.com/modx.html
My MODX Extras
Bob's Guides is now hosted at A2 MODX Hosting