Overview

Namespaces

  • rsanchez
    • Deep
      • App
        • EE
        • Laravel
          • Facade
      • Collection
      • Hydrator
      • Model
      • Plugin
      • Relations
      • Repository

Classes

  • BasePlugin
  • Overview
  • Namespace
  • Class
  • Tree

Class BasePlugin

Base class for EE modules/plugins

Abstract
Namespace: rsanchez\Deep\Plugin
Located at Plugin/BasePlugin.php
Methods summary
public
# __construct( )

Constructor

Constructor

protected array
# getEntriesDefaultParameters( )

Get the default tag parameters when using parseEntries

Get the default tag parameters when using parseEntries

Returns

array
protected array
# getCategoriesDefaultParameters( )

Get the default tag parameters when using parseEntries

Get the default tag parameters when using parseEntries

Returns

array
protected rsanchez\Deep\Collection\EntryCollection
# getEntries( Closure $callback = null )

Get an EntryCollection based on the state of ee()->TMPL

Get an EntryCollection based on the state of ee()->TMPL

Parameters

$callback
Closure|null
$callback receieves a query builder object as the first parameter

Returns

rsanchez\Deep\Collection\EntryCollection
public string
# parseEntries( Closure $callback = null )

Parse a plugin tag pair equivalent to channel:entries

Parse a plugin tag pair equivalent to channel:entries

Parameters

$callback
Closure|null
$callback receieves a query builder object as the first parameter

Returns

string
protected string
# parseEntryCollection( rsanchez\Deep\Collection\AbstractTitleCollection $entries, string $tagdata, array $params = array(), array $varPair = array(), array $varSingle = array() )

Parse a plugin tag pair equivalent to channel:entries

Parse a plugin tag pair equivalent to channel:entries

Parameters

$entries
rsanchez\Deep\Collection\AbstractTitleCollection
$entries a collection of entries
$tagdata
string
$tagdata the raw template to parse
$params
array
$params channel:entries parameters
$varPair
array
$varPair array of pair tags from ee()->functions->assign_variables
$varSingle
array
$varSingle array single tags from ee()->functions->assign_variables

Returns

string
protected string
# parseCategories( Closure $callback = null )

Parse a plugin tag pair equivalent to channel:categories

Parse a plugin tag pair equivalent to channel:categories

Parameters

$callback
Closure|null
$callback receieves a query builder object as the first parameter

Returns

string
protected
# categoryCollectionToVariables( rsanchez\Deep\Collection\CategoryCollection $categories, array & $variables, boolean $customFieldsEnabled = false, string $prefix = '' )

Convert a Category collection into a multi-dimensional array suitable for ee()->TMPL->parse_variables

Convert a Category collection into a multi-dimensional array suitable for ee()->TMPL->parse_variables

Parameters

$categories
rsanchez\Deep\Collection\CategoryCollection
$categories
$variables
array
$variables
$customFieldsEnabled
boolean
$customFieldsEnabled
$prefix
string
$prefix
protected array
# categoryToVariables( rsanchez\Deep\Model\Category $category, boolean $customFieldsEnabled = false, string $prefix = '' )

Convert a Category model into an array suitable for ee()->TMPL->parse_variables_row

Convert a Category model into an array suitable for ee()->TMPL->parse_variables_row

Parameters

$category
rsanchez\Deep\Model\Category
$category
$customFieldsEnabled
boolean
$customFieldsEnabled
$prefix
string
$prefix

Returns

array
protected string
# categoryToList( rsanchez\Deep\Model\Category $category, [type] $tagdata, boolean $customFieldsEnabled = false, string $prefix = '' )

Convert a Category model into a list element

Convert a Category model into a list element

Parameters

$category
rsanchez\Deep\Model\Category
$category
$tagdata
[type]
$tagdata
$customFieldsEnabled
boolean
$customFieldsEnabled
$prefix
string
$prefix

Returns

string
Properties summary
protected rsanchez\Deep\Deep $app
#
protected Pagination_object $paginator
#
API documentation generated by ApiGen 2.8.0