https://github.com/sergant210/modxhelpers
Library of the helpfull functions for MODX as composer package
https://github.com/sergant210/modxhelpers
composer modx
Last synced: 2 months ago
JSON representation
Library of the helpfull functions for MODX as composer package
- Host: GitHub
- URL: https://github.com/sergant210/modxhelpers
- Owner: sergant210
- Created: 2016-12-31T08:39:09.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-13T04:28:57.000Z (about 7 years ago)
- Last Synced: 2025-04-14T01:44:51.335Z (6 months ago)
- Topics: composer, modx
- Language: PHP
- Homepage:
- Size: 56.6 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
Awesome Lists containing this project
README
## MODX Helpers
Functions-helpers for MODX. It's made as composer package. Depricated. See [modHelpers](https://github.com/sergant210/modHelpers).
### Installation
- Create a plugin which loads composer files.
```php
switch ($modx->event->name) {
case 'OnMODXInit':
$file = MODX_CORE_PATH . 'vendor/autoload.php';
if (file_exists($file)) {
require_once $file;
}
break;
}
```
- Put the composer.json to the *core* folder
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/sergant210/modxhelpers"
}
],
"minimum-stability": "dev",
"require": {
"sergant210/modxhelpers": "1.*"
}
}
```
- Use a terminal tool and run ```composer install``` or ```php composer.phar install``` within the folder *core*.
That's all. Now you can use the functions.
### Examples
**Check the user exists**
```php
if (user_exists(['email'=>'admin@mail.com']) {
// Exists
}
```
**Get the data from the cache**
```php
$value = cache('key', 'my_data');
// Or
$value = cache()->get('key', 'my_data');
```
**Send an email**
```php
email('pussycat@mail.ru', 'Subject','Email content');
// To the user
email_user('admin', $subject, $content);
```
**Redirect**
```php
redirect($url);
//To the resource with the id = 5
redirect(5);
```
**The latest resource**
```php
$resourceObject = resource()->last(); // Resource object
$resourceArray = resource()->last()->toArray(); // Resource data as array
```
**The last 10 resources**
```php
$resObjects = resources()->last(10);
```
**Array of the resource pagetitles of the parent with the id = 20.**
```php
$titles= resources()->where(['parent'=>20])->get('pagetitle'); // array('pagetitle 1', 'pagetitle 2', 'pagetitle 3')
```
**Set a value to the session**
```php
session('key1.key2', 'value'); // => $_SESSION['key1']['key2'] = $value;
```
**Get the value from session**
```php
$value = session('key1.key2'); // $value = $_SESSION['key1']['key2']
```
**Validates the email**
```php
if (is_email($_POST['email'])) {
// Valid
}
```
**Remove child resources of the one with the id = 10**
```php
resources()->where(['parent'=>10])->remove();
```
**Count blocked users**
```php
$count = users()->profile()->where(['Profile.blocked'=>1])->count();
```
**Load script with the async attribute**
```php
script('/path/to/script.js', 'async'); //
```
**Get an array of users**
```php
// Can use the prepared query
$userArray = query('select * from ' . table_name('modUser'). ' WHERE id < ?')->execute(( (int) $_POST['user_id']);
```
**Log error to the error log**
```php
log_error($array); // Convert the array to string using print_r().
log_error($message, 'HTML'); // Show message on the page.
```
**Get the list of the pagetitles**
```php
return resources()->where(['id:IN'=>children(5)])->each(function($resource, $idx){ return "
```
**Get all users which are members of the "Manager" group**
```php
$usersArray = users()->members('Managers')->toArray();
# Get all users from "ContentManagers" and "SaleManagers" groups
$users = users()->members('%Managers')->get();
foreach($users as $user) {
echo $user->username;
}
```
[Russian documentation](./docs/ru.md)
[English documentation](./docs/en.md)