MODX

https://docs.modx.com/current/en/
Admin
MODX is an open-source content management system and web application framework designed to give...
Tokens:1,060,375
Snippets:10,258
Trust Score:9.5
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install a transport package

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdotransport/xpdotransport.install

A basic example showing how to trigger the installation of a transport package.

```php
$transport->install();
```

--------------------------------

### Setup options script setup.options.php

Source: https://docs.modx.com/current/en/extending-modx/tutorials/developing-an-extra/part-3

A PHP script that returns HTML to be displayed during the package installation process.

```php
<?php
$output = '';
switch ($options[xPDOTransport::PACKAGE_ACTION]) {
    case xPDOTransport::ACTION_INSTALL:
        $output = '<h2>Doodles Installer</h2>
<p>Thanks for installing Doodles! Please review the setup options below before proceeding.</p><br />';
        break;
    case xPDOTransport::ACTION_UPGRADE:
    case xPDOTransport::ACTION_UNINSTALL:
        break;
}
return $output;
```

--------------------------------

### Get registered startup scripts

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.getregisteredclientstartupscripts

Example of retrieving all registered startup scripts into an array.

```php
$startupScripts = $modx->getRegisteredClientStartupScripts();
```

--------------------------------

### Define Setup Options Form

Source: https://docs.modx.com/current/en/extending-modx/transport-packages/build-script

Create a setup.options.php file to generate a dynamic HTML form for user input during package installation or upgrade.

```php
<?php
/**
 * Build the setup options form.
 *
 * @package quip
 * @subpackage build
 */
/* set some default values */
$values = array(
    'emailsTo' => 'my@emailhere.com',
    'emailsFrom' => 'my@emailhere.com',
    'emailsReplyTo' => 'my@emailhere.com',
);
switch ($options[xPDOTransport::PACKAGE_ACTION]) {
    case xPDOTransport::ACTION_INSTALL:
    case xPDOTransport::ACTION_UPGRADE:
        $setting = $modx->getObject('modSystemSetting',array('key' => 'quip.emailsTo'));
        if ($setting != null) { $values['emailsTo'] = $setting->get('value'); }
        unset($setting);

        $setting = $modx->getObject('modSystemSetting',array('key' => 'quip.emailsFrom'));
        if ($setting != null) { $values['emailsFrom'] = $setting->get('value'); }
        unset($setting);

        $setting = $modx->getObject('modSystemSetting',array('key' => 'quip.emailsReplyTo'));
        if ($setting != null) { $values['emailsReplyTo'] = $setting->get('value'); }
        unset($setting);
    break;
    case xPDOTransport::ACTION_UNINSTALL: break;
}

$output = '<label for="quip-emailsTo">Emails To:</label>
<input type="text" name="emailsTo" id="quip-emailsTo" width="300" value="'.$values['emailsTo'].'" />
<br /><br />

<label for="quip-emailsFrom">Emails From:</label>
<input type="text" name="emailsFrom" id="quip-emailsFrom" width="300" value="'.$values['emailsFrom'].'" />
<br /><br />

<label for="quip-emailsReplyTo">Emails Reply-To:</label>
<input type="text" name="emailsReplyTo" id="quip-emailsReplyTo" width="300" value="'.$values['emailsReplyTo'].'" />';

return $output;
```

--------------------------------

### Run New CLI Installation

Source: https://docs.modx.com/current/en/getting-started/installation/cli

Execute this command from the MODX setup directory to perform a new installation after configuring the XML file.

```bash
php ./index.php --installmode=new
```

--------------------------------

### getResources Example

Source: https://docs.modx.com/current/en/extras/boilerx/bx-bottom-close

An example of using the getResources snippet to fetch resources.

```modx
[[getResources@section?
    &parents=`1316`
    &context=`extras`
    &limit=`0`
    &resources=`1316,[[*id]]`
]]
```

--------------------------------

### Start Item Template Example

Source: https://docs.modx.com/current/en/extras/wayfinder

Example of how &startItemTpl can be used to display a menu start item.

```html
<h2 class="menustart"><a href="[+wf.link+]">[+wf.linktext+]</a></h2>[+wf.wrapper+]
```

--------------------------------

### Example: Get user comment count

Source: https://docs.modx.com/current/en/extras/quip/quip.quipcount

Example usage to count comments for the user 'mikegeorge'.

```MODX
[[QuipCount? &type=`user` &user=`mikegeorge`]]
```

--------------------------------

### Example: Get thread comment count

Source: https://docs.modx.com/current/en/extras/quip/quip.quipcount

Example usage to count comments in the thread named 'thread32'.

```MODX
[[QuipCount? &thread=`thread32`]]
```

--------------------------------

### Initialize build script timer and environment

Source: https://docs.modx.com/current/en/extending-modx/transport-packages/build-script

Sets up the initial PHP documentation, starts a timer to track build duration, and disables the script timeout limit.

```php
<?php
/**
 * Quip build script
 *
 * @package quip
 * @subpackage build
 */
$mtime = microtime();
$mtime = explode(" ", $mtime);
$mtime = $mtime[1] + $mtime[0];
$tstart = $mtime;
set_time_limit(0); /* makes sure our script doesnt timeout */
```

--------------------------------

### Example Option Set with Settings

Source: https://docs.modx.com/current/en/extras/fred/themer/options/settings

A comprehensive example demonstrating various setting types including text, image, file, textarea, select, slider, and a nested CTA group.

```json
{
    "remote": true,
    "settings": [
        {
            "name": "panel_class",
            "label": "Panel Classes",
            "type": "text",
            "value": "col-6 col-sm-12"
        },
        {
            "name": "logo",
            "label": "Logo",
            "type": "image",
            "mediaSource": "site-assets",
            "value": "assets/images/logo.svg"
        },
        {
            "name": "nda-file",
            "label": "Upload NDA",
            "type": "file",
            "mediaSource": "site-assets-files",
            "value": "assets/files/contract.pdf"
        },
        {
            "name": "slogan",
            "label": "Slogan",
            "type": "textarea",
            "value": "Enter your slogan here"
        },
        {
            "name": "panel_type",
            "label": "Type of Panel",
            "type": "select",
            "options": {
                "info": "Info Panel",
                "warn": "Warning Panel",
                "error": "Error panel"
            },
            "value": "info"
        },
        {
            "name": "padding_top",
            "label": "Top padding",
            "type": "slider",
            "min": 0,
            "max": 100,
            "step": 10,
            "value": 20
        },
        {
            "group": "CTA",
            "settings": [
                {
                    "name": "cta_class",
                    "label": "CTA Class",
                    "type": "select",
                    "options": {
                        "danger": "Red CTA",
                        "info": "Blue CTA",
                        "default": "Default CTA"
                    },
                    "value": "default"
                },
                {
                    "name": "show_cta",
                    "label": "Show CTA",
                    "type": "toggle",
                    "value": false
                },
                {
                    "name": "color",
                    "label": "Text Color",
                    "type": "colorswatch",
                    "value": "black",
                    "options": [
                        {
                            "value": "primary",
                            "color": "blue",
                            "label": "Primary"
                        },
                        "lightcoral",
                        "black",
                        "rgba(0,255,0,.5)"
                    ]
                },
                {
                    "name": "bg_color",
                    "label": "Background COlor",
                    "type": "colorpicker",
                    "value": "white",
                    "showAlpha": true,
                    "options": ["lightcoral", "black", "white"]
                },
                {
                    "name": "page",
                    "label": "Linked Page",
                    "type": "page",
                    "value": { "id": 1, "url": "[[~1]]" }
                }
            ]
        }
    ]
}
```

--------------------------------

### Run Basic Upgrade

Source: https://docs.modx.com/current/en/getting-started/installation/cli

Execute this command from the setup directory to perform a basic upgrade using the configuration defined in your XML file.

```bash
php ./index.php --installmode=upgrade
```

--------------------------------

### Get User Settings Example

Source: https://docs.modx.com/current/en/extending-modx/core-model/moduser/moduser.getsettings

Retrieves all User Settings for the specified user object.

```php
$settings = $user->getSettings();
```

--------------------------------

### Run a Snippet with Parameters

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.runsnippet

Example of executing a snippet named 'Welcome' and passing a 'name' parameter, then outputting the result.

```php
$output = $modx->runSnippet('Welcome',array(
   'name' => 'John'
));
echo $output; // prints 'Welcome John!'
```

--------------------------------

### Get Debug State

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdo/xpdo.getdebug

Example showing how to retrieve the current debug status from an xPDO instance.

```php
$isDebugOn = $xpdo->getDebug();
```

--------------------------------

### Simple cache setting and getting

Source: https://docs.modx.com/current/en/extending-modx/caching

Demonstrates writing data to the default cache partition with an expiry time and retrieving it.

```php
$str = 'My test cached data.';
// Writes the data to the default cache partition with an expiry time of 2 hours.
$modx->cacheManager->set('testdata', $str, 7200);
// Gets the data from cache again. Returns null if cache is not available or expired.
$str = $modx->cacheManager->get('testdata');
```

--------------------------------

### CLI Usage Example

Source: https://docs.modx.com/current/en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1

An example of executing the upgrade script via CLI with multiple arguments.

```bash
user@hostname:/home/user/xpdo$ php xpdo/tools/schema/upgrade-mysql-1.1.php --pkg=sample --pkg_path=models/ --schema_name=sample.mysql.schema.xml --schema_path=schemas/ --echo --write --regen
```

--------------------------------

### Get the MODX Parser object

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.getparser

Example showing how to assign the MODX parser instance to a variable.

```php
$parser = $modx->getParser();
```

--------------------------------

### selfLink snippet call

Source: https://docs.modx.com/current/en/extras/selflink

Example of calling the selfLink snippet to get a link to the next resource in the tree.

```APIDOC
## selfLink Snippet

### Description
Creates a link or anchor to a page based on the specified direction (up, next, previous).

### Parameters
- **direction** (string) - Required - Direction of the link: 'up', 'next', or 'previous'.
- **id** (integer) - Optional - ID of the resource where the link must be from. Defaults to current page ID.
- **tpl** (string) - Optional - Chunk name for link presentation. Defaults to `<a href="...">Title</a>`.
- **linktext** (string) - Optional - Alternative link text. Defaults to the resource pagetitle.

### Example
```
[[selfLink? &direction=`next`]]
```
```

--------------------------------

### Initialize extension_packages System Setting

Source: https://docs.modx.com/current/en/extending-modx/custom-users

Use this JSON snippet if the extension_packages system setting does not yet exist.

```json
[{"extendeduser":{"path":"[[++core_path]]components/extendeduser/model/"}}]
```

--------------------------------

### Display Hello World with Inline PHP

Source: https://docs.modx.com/current/en/building-sites/client-proofing/dashboards/widget-types/inline-php

A basic example of returning a string from an Inline PHP widget to display content.

```php
<?php
return 'Hello, World!';
```

--------------------------------

### Get Select Columns for modChunk

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdoobject/metadata-accessors/getselectcolumns

A basic example showing how to retrieve the column string for the 'modChunk' class.

```php
$columnString = xPDOObject::getSelectColumns($xpdo,'modChunk');
```

--------------------------------

### Get the modSmarty service

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.getservice

A basic example of loading the modSmarty service using its key and class name.

```php
$modx->getService('smarty','smarty.modSmarty');
```

--------------------------------

### Define Build Paths and Environment

Source: https://docs.modx.com/current/en/extending-modx/tutorials/developing-an-extra/part-3

Sets up the directory structure array and includes necessary MODX configuration and class files.

```php
/* define build paths */
$root = dirname(dirname(__FILE__)).'/';
$sources = array(
    'root' => $root,
    'build' => $root . '_build/',
    'data' => $root . '_build/data/',
    'resolvers' => $root . '_build/resolvers/',
    'chunks' => $root.'core/components/'.PKG_NAME_LOWER.'/chunks/',
    'lexicon' => $root . 'core/components/'.PKG_NAME_LOWER.'/lexicon/',
    'docs' => $root.'core/components/'.PKG_NAME_LOWER.'/docs/',
    'elements' => $root.'core/components/'.PKG_NAME_LOWER.'/elements/',
    'source_assets' => $root.'assets/components/'.PKG_NAME_LOWER,
    'source_core' => $root.'core/components/'.PKG_NAME_LOWER,
);
unset($root);

/* override with your own defines here (see build.config.sample.php) */
require_once $sources['build'] . 'build.config.php';
require_once MODX_CORE_PATH . 'model/modx/modx.class.php';
```

--------------------------------

### Get authenticated user for a specific context

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.getauthenticateduser

Example showing how to retrieve the authenticated user for the 'sports' context.

```php
$user = $modx->getAuthenticatedUser('sports');
```

--------------------------------

### Initialize a Context

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.initialize

Example showing how to initialize the 'sports' context.

```php
$modx->initialize('sports');
```

--------------------------------

### Create a directory with writeTree

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdocachemanager/xpdocachemanager.writetree

An example showing how to create a new directory on the filesystem using the writeTree method.

```php
$xpdo->cacheManager->writeTree('/path/to/new/directory/');
```

--------------------------------

### Get Related Objects Example

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdoobject/related-object-accessors/getmany

Retrieves all Chunk objects associated with a specific Category and iterates through them to output their names.

```php
$category = $xpdo->getObject('Category',1);
$chunks = $category->getMany('Chunk');
foreach ($chunks as $chunk) {
   echo $chunk->get('name').'<br />';
}
```

--------------------------------

### Initializing build.schema.php

Source: https://docs.modx.com/current/en/extending-modx/tutorials/using-custom-database-tables

The initial setup for the schema build script, including path definitions and MODX initialization.

```php
<?php
/**
 * Build Schema script
 *
 * @package storefinder
 * @subpackage build
 */
$mtime = microtime();
$mtime = explode(" ", $mtime);
$mtime = $mtime[1] + $mtime[0];
$tstart = $mtime;
set_time_limit(0);
require_once dirname(__FILE__) . '/build.config.php';
include_once MODX_CORE_PATH . 'model/modx/modx.class.php';
$modx= new modX();
$modx->initialize('mgr');
$modx->loadClass('transport.modPackageBuilder','',false, true);
$modx->setLogLevel(modX::LOG_LEVEL_INFO);
$modx->setLogTarget(XPDO_CLI_MODE ? 'ECHO' : 'HTML');
$root = dirname(dirname(__FILE__)).'/';
$sources = array(
    'root' => $root,
    'core' => $root.'core/components/storefinder/',
    'model' => $root.'core/components/storefinder/model/',
    'assets' => $root.'assets/components/storefinder/',
    'schema' => $root.'_build/schema/',
);
```

--------------------------------

### Get a Resource Tree

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.gettree

Example of retrieving a tree for the resource with ID 12, limited to a depth of 5 levels.

```php
$treeArray = $modx->getTree(12,5);
```

--------------------------------

### TaggerGetTags Example Usage

Source: https://docs.modx.com/current/en/extras/tagger

Example MODX snippet calls for common use cases: listing all tags including unused, filtering by groups, and getting tags for the current resource (using [[*id]] or [[+id]] in getResources templates).

```MODX
// Get tags for all resources, including unused tags
[[TaggerGetTags? &showUnused=`1`]]
// Get tags from groups 1 and 3 for all resources
[[TaggerGetTags? &groups=`1,3` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource
[[!TaggerGetTags? &resources=`[[*id]]` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource in getResources tpl
[[!TaggerGetTags? &resources=`[[+id]]` &rowTpl=`tag_links_tpl`]]
```

--------------------------------

### Web Request Usage Example

Source: https://docs.modx.com/current/en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1

An example URL for executing the upgrade script as a web request.

```http
http://localhost/food/xpdo/tools/schema/upgrade-mysql-1.1.php?pkg=sample&pkg_path=models/&schema_name=sample.mysql.schema.xml&schema_path=schemas/&echo=true&write=true&regen=true
```

--------------------------------

### Copy Build Configuration Files

Source: https://docs.modx.com/current/en/contribute/code/contributors-guide

Create the necessary build configuration files by copying the provided samples.

```bash
cp build.config.sample.php build.config.php
cp build.properties.sample.php build.properties.php
```

--------------------------------

### Retrieve a Cache Provider

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdocachemanager/xpdocachemanager.getcacheprovider

Example showing how to get a cache manager instance and then retrieve a specific cache provider, such as xPDOMemCache.

```php
$cacheManager = $xpdo->getCacheManager();
$provider = $cacheManager->getCacheProvider('xPDOMemCache');
```

--------------------------------

### Basic tolinks usage example

Source: https://docs.modx.com/current/en/extras/taglister/taglister.tolinks

Converts the 'tags' Template Variable into links pointing to Resource 123 with a 'tag' GET parameter.

```text
[[!tolinks? &items=`[[*tags]]` &key=`tag` &target=`123`]]
```

--------------------------------

### Properties File Example

Source: https://docs.modx.com/current/en/extending-modx/xpdo/custom-models/defining-a-schema/upgrade-schema-v1.0-to-v1.1

An example of a PHP properties file used to define arguments for the upgrade script.

```php
<?php
$pkg='sample';
$pkg_path='models/';
$schema_name='sample.mysql.schema.xml';
$schema_path='schemas/';
$echo=true;
$write=true;
$regen=true;
```

--------------------------------

### Print current full version

Source: https://docs.modx.com/current/en/extending-modx/modx-class/reference/modx.getversiondata

Example showing how to retrieve the version data array and output the full version string.

```php
$vers = $modx->getVersionData();
echo $vers['full_version'];
```

--------------------------------

### Perform Ajax request with jQuery

Source: https://docs.modx.com/current/en/extras/pdoTools/Snippets/pdoPage

Example of sending a GET request to a page with the page parameter to retrieve JSON data from pdoPage.

```javascript
$.get('document.html?page=5', function(response) {
    console.log(response);
}, 'json');
```

--------------------------------

### Configuring xPDO::OPT_CONN_INIT

Source: https://docs.modx.com/current/en/extending-modx/xpdo/create-xpdo-instance/connections

Example of setting the initial connection criteria to ensure a read-only connection is used by default.

```php
xPDO::OPT_CONN_INIT => array(xPDO::_OPT_CONN_MUTABLE => false)
```

--------------------------------

### xPDO::addPackage with FormIt Example

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdo/xpdo.addpackage

An example of loading a specific package (recaptcha) from the FormIt component structure.

```php
$xpdo->addPackage('recaptcha', MODX_CORE_PATH.'components/formit/model/');
```

--------------------------------

### Populating an Object from JSON

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdoobject/field-accessors/fromjson

An example demonstrating how to initialize an object's fields using a JSON string and retrieve the values using the get method.

```php
$str = '{"name":"Sirius","email":"Black"}';
$object->fromJSON($str);
echo $object->get('name').' '.$object->get('email');
// prints "Sirius Black"
```

--------------------------------

### Create a simple form with fieldSetDefaults

Source: https://docs.modx.com/current/en/extras/formitfastpack/formitfastpack.field

Example of a complete form using FormIt, fieldSetDefaults for global configuration, and multiple field types.

```MODX
[[!FormIt? &prefix=`myprefix.` &submitVar=`submitForm`]]
<form action="[[~[[*id]]]]" method="post">
    [[!fieldSetDefaults? &prefix=`myprefix.` &outer_tpl=`myWrapTpl` &resetDefaults=`1`]]
    [[!field? &name=`full_name` &type=`text` &class=`required`]]
    [[!field? &name=`favorite_color` &type=`checkbox` &options=`Blue||Red||Yellow`]]
    [[!field? &name=`location` &type=`select` &label=`Where are you from?` &options=`United States==US||New Zealand==NZ||Never Never Land==NNL`]]
    [[!field? &name=`message` &type=`textarea`]]
    [[!field? &name=`submitForm` &type=`submit` &label=` ` &message=`Submit Form`]]
</form>
```

--------------------------------

### Example: Get iterator for Box objects with width 40

Source: https://docs.modx.com/current/en/extending-modx/xpdo/class-reference/xpdo/xpdo.getiterator

Demonstrates using getIterator to loop over a collection of Box objects and output their id and width.

```php
$boxes = $xpdo->getIterator('Box',array(
   'width' => 40,
));
foreach ($boxes as $idx => $box) {
    echo "Box #{$idx} has an id of {$box->get('id')} and a width of {$box->get('width')}\n";
}
```
Tokens:
Raw