model/modx/sqlsrv/modresource.class.php

Includes Classes 
package
modx
subpackage
sqlsrv
Classes
modResource_sqlsrv

Description

\modResource_sqlsrv

Extends from
\modResource
package
modx
Methods
getTemplateVarCollection
listGroups

Description

Represents a web resource managed by the modX framework.

This is the basis for the entire xPDO object model, and can also be used by a class generator {@link xPDOGenerator}, ultimately allowing custom classes to be user-defined in a web interface and framework-generated at runtime.

Methods

getTemplateVarCollection

getTemplateVarCollection( \modResource $resource ) : \A

Retrieve a collection of Template Variables for a Resource.

Arguments
$resource
\modResource
&$resource A reference to the modResource to retrieve TemplateVars for.
Output
\A
collection of modTemplateVar instances for the modResource.
Details
visibility
public
final
false
static
true

listGroups

listGroups( \modResource $resource, array $sort = array, int $limit = 0, int $offset = 0 ) : array

Get a sortable, limitable collection (and total count) of Resource Groups for a given Resource.

Arguments
$resource
\modResource
&$resource A reference to the modResource to get the groups from.
$sort
array
An array of sort columns in column => direction format.
$limit
int
A limit of records to retrieve in the collection.
$offset
int
A record offset for a limited collection.
Output
array
An array containing the collection and total.
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox 0.11.2.