Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • PHP
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SIWECOS
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • pApiContentAllocation
  • pApiContentAllocationArticle
  • pApiContentAllocationComplexList
  • pApiContentAllocationSelectBox
  • pApiContentAllocationTreeView
  • pApiTree

Functions

  • pica_ArticleListActions
  • pica_GetCustomTabProperties
  • pica_RegisterCustomTab
  • pica_RenderArticleAction
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class pApiContentAllocation

Main class for content allocation

Package: Plugin\ContentAllocation
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Marco Jahn
Located at plugins/content_allocation/classes/class.content_allocation.php
Methods summary
public
# __construct( )

pApiContentAllocation constructor

pApiContentAllocation constructor

public
# pApiContentAllocation( )

Old constructor

Old constructor

Deprecated

[2016-02-11] This method is deprecated and is not needed any longer. Please use __construct() as constructor function.
public
# storeAllocations( integer $idartlang, array $allocations )

Store allocations

Store allocations

Parameters

$idartlang
integer
$idartlang
$allocations
array
$allocations

Throws

cDbException
public
# deleteAllocations( integer $idpica_alloc )

Delete allocations by allocation id

Delete allocations by allocation id

Parameters

$idpica_alloc
integer
$idpica_alloc

Throws

cDbException
public
# deleteAllocationsByIdartlang( integer $idartlang )

Delete allocations by language id

Delete allocations by language id

Parameters

$idartlang
integer
$idartlang

Throws

cDbException
public array
# loadAllocations( integer $idartlang )

Load all tagging keys

Load all tagging keys

Parameters

$idartlang
integer
$idartlang

Returns

array
$result

Throws

cDbException
public array
# loadAllocationsWithNames( integer $idartlang, integer $parent, boolean $firstonly = false )

Load allocations by language id and parent id

Load allocations by language id and parent id

Parameters

$idartlang
integer
$idartlang
$parent
integer
$parent
$firstonly
boolean
$firstonly [optional]

Returns

array

Throws

cDbException
public string
# findMatchingContent( array $restrictions = null, integer $max = 0 )

Build query to find matching content by ContentAllocation

Build query to find matching content by ContentAllocation

Parameters

$restrictions
array
$restrictions [optional]
$max
integer
$max [optional]

Returns

string
$sql
protected string
# _buildQuery( array $restrictions, array $categoriesToExclude, integer $max )

Build query to find matching content by ContentAllocation

Build query to find matching content by ContentAllocation

Parameters

$restrictions
array
$restrictions
$categoriesToExclude
array
$categoriesToExclude
$max
integer
$max

Returns

string
$sql
public array
# findMatchingContentByContentAllocationByCategories( array $contentAllocation, array $categories = array(), integer $offset = 0, integer $numOfRows = 0 )

Search articles by ContentAllocation and catgories

Search articles by ContentAllocation and catgories

Parameters

$contentAllocation
array
$contentAllocation
$categories
array
$categories
$offset
integer
$offset [optional]
$numOfRows
integer
$numOfRows [optional]

Returns

array
of articles

Throws

cDbException
protected string
# _buildQuery_MatchingContentByContentAllocationByCategories( array $contentAllocation, array $categories, integer $offset, integer $numOfRows )

Build SQL query to find articles by ContentAllocation and catgories

Build SQL query to find articles by ContentAllocation and catgories

Parameters

$contentAllocation
array
$contentAllocation
$categories
array
$categories
$offset
integer
offset
$numOfRows
integer
numOfRows

Returns

string
public array
# findMatchingContentByCategories( array $categories = array(), integer $offset = 0, integer $numOfRows = 0, string $resultType = '' )

Search articles by catgories without start articles

Search articles by catgories without start articles

Parameters

$categories
array
$categories [optional]
$offset
integer
$offset [optional]
$numOfRows
integer
$numOfRows [optional]
$resultType
string
$resultType element of {article_id, object} [optional]

Returns

array
of articles

Throws

cDbException
public string
# _buildQuery_MatchingContentByCategories( array $categories, integer $offset, integer $numOfRows )

Build SQL query to find articles by catgories

Build SQL query to find articles by catgories

Parameters

$categories
array
$categories
$offset
integer
offset
$numOfRows
integer
numOfRows

Returns

string
$sql
Properties summary
protected cDb $_db null
#

References database object

References database object

protected boolean $_debug false
#
protected array $_table array()
#
protected integer $_lang 0
#
protected integer $_client 0
#
protected object $_treeObj null
#
CMS CONTENIDO 4.10.1 API documentation generated by ApiGen 2.8.0