Difference between revisions of "Core"

From PunchCMS
Jump to: navigation, search
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
====== SpinCMS Core Class ======
+
=== PunchCMS Instansiation ===
−
===== SpinCMS Instansiation =====
+
==== [[Core/singleton|PCMS_Client::singleton(dsn, account, basePath)]] ====
−
=== PCMS_Client::singleton (dsn, account, basePath) ===
+
Instansiate the singleton class. This is done only once during the execution of a page.
−
Instansiate the singleton class. This is done only once during the execution of a page.\\
+
==== [[Core/getInstance|PCMS_Client::getInstance()]] ====
−
**[[Core/singleton|Details]]**
+
Get the CMS object instance. This way you don't have to work with a global CMS object.
−
=== PCMS_Client::getInstance () ===
+
=== PunchCMS Methods ===
−
Get the CMS object instance. This way you don't have to work with a global CMS object.\\
+
==== [[Core/get|get([elementApiName], [recursive])]] ====
−
**[[Core/getinstance|Details]]**
+
Get the first element or folder with an optional specific api name from the root folder.
−
===== SpinCMS Methods =====
+
==== [[Core/getElements|getElements([elementApiName], [getFirst], [recursive])]] ====
−
=== get ([elementApiName], [recursive]) ===
+
Get a collection of elements and folders with an optional specific api name from the root folder.
−
Get the first element or folder with an optional specific api name from the root folder.\\
+
==== [[Core/getFolders|getFolders([elementApiName], [getFirst])]] ====
−
**[[Core/get|Details]]**
+
Get a collection of folders with an optional specific api name from the root folder.
−
=== getElements ([elementApiName], [getFirst], [recursive]) ===
+
==== [[Core/getElementById|getElementById(elementId)]] ====
−
Get a collection of elements and folders with an optional specific api name from the root folder.\\
+
Get an element or folder with a specific id from the CMS. If not found it will return NULL.
−
**[[Core/getelements|Details]]**
+
==== [[Core/getFieldById|getFieldById(elementFieldId)]] ====
−
=== getFolders ([elementApiName], [getFirst]) ===
+
Get a field with a specific id from the CMS.
−
Get a collection of folders with an optional specific api name from the root folder.\\
+
==== [[Core/getElementByTemplate|getElementByTemplate(templateApiName, [recursive], [random])]] ====
−
**[[Core/getfolders|Details]]**
+
Get the first element with a specific template api name from the root folder.
−
=== getElementById (elementId) ===
+
==== [[Core/getElementsByTemplate|getElementsByTemplate(templateApiName, [getFirst], [recursive], [random])]] ====
−
Get an element or folder with a specific id from the CMS. If not found it will return NULL.\\
+
Get a collection of elements with a specific template api name from the root folder.
−
**[[Core/getelementbyid|Details]]**
+
==== [[Core/getElementByTemplateId|getElementByTemplateId(templateId, [recursive], [random])]] ====
−
=== getFieldById (elementFieldId) ===
+
Get the first element with a specific template id from the root folder.
−
Get a field with a specific id from the CMS.\\
+
==== [[Core/getElementsByTemplateId|getElementsByTemplateId(templateId, [getFirst], [recursive], [random])]] ====
−
**[[Core/getfieldbyid|Details]]**
+
Get a collection of elements with a specific template id from the root folder.
−
=== getElementByTemplate (templateApiName, [recursive], [random]) ===
+
==== [[Core/getElementsFromParent|getElementsFromParent(elementId, [getFirst], [recursive])]] ====
−
Get the first element with a specific template api name from the root folder.\\
+
Get a list of elements with a specific parent id.
−
**[[Core/getelementbytemplate|Details]]**
+
==== [[Core/getAliasId|getAliasId()]] ====
−
=== getElementsByTemplate (templateApiName, [getFirst], [recursive], [random]) ===
+
Get the element id converted from the curent URL alias.
−
Get a collection of elements with a specific template api name from the root folder.\\
+
==== [[Core/find|find(query, filters, [exact], [arrAllowedTypes])]] ====
−
**[[Core/getelementsbytemplate|Details]]**
+
Search through the CMS using a query and optional filters.
−
=== getElementByTemplateId (templateId, [recursive], [random]) ===
+
==== [[Core/getLanguages|getLanguages()]] ====
−
Get the first element with a specific template id from the root folder.\\
+
Get a collection of all active languages.
−
**[[Core/getelementbytemplateid|Details]]**
+
==== [[Core/getLanguage|getLanguage()]] ====
−
=== getElementsByTemplateId (templateId, [getFirst], [recursive], [random]) ===
+
Get the currently active language.
−
Get a collection of elements with a specific template id from the root folder.\\
+
==== [[Core/getBasePath|getBasePath()]] ====
−
**[[Core/getelementsbytemplateid|Details]]**
+
Get the base path to the website.
−
=== getElementsFromParent (elementId, [getFirst], [recursive]) ===
+
==== [[Core/setBasePath|setBasePath(value)]] ====
−
Get a list of elements with a specific parent id.\\
+
Set the base path of the website. This overrides the value from the singleton method.
−
**[[Core/getelementsfromparent|Details]]**
+
==== [[Core/getFilePath|getFilePath()]] ====
−
=== getAliasId () ===
+
Get the base path to files uploaded by the CMS.
−
Get the element id converted from the curent URL alias.\\
+
==== [[Core/getDownloadPath|getDownloadPath()]] ====
−
**[[Core/getaliasid|Details]]**
+
Get the base path to files uploaded by the CMS relative to the website path.
−
=== find (query, filters, [exact], [arrAllowedTypes]) ===
+
==== [[Core/getFromCache|getFromCache(method, elementId, [arguments])]] ====
−
Search through the CMS using a query and optional filters.\\
+
Get the output of a method from the cache. If output doesn't exist is will call the method, cache and return the output.
−
**[[Core/find|Details]]**
+
==== [[Core/getSetting|getSetting(value)]] ====
−
=== getLanguages () ===
+
Get the value of a setting in the CMS.
−
Get a collection of all active languages.\\
+
==== [[Core/useAliases|useAliases(value)]] ====
−
**[[Core/getlanguages|Details]]**
+
Set wether aliases should be used or not. Using aliases has a slight performance impact.
−
=== getLanguage () ===
+
==== [[Core/setDbConnection|setDbConnection([reInit])]] ====
−
Get the currently active language.\\
+
This method forces a reset on the internal database connection object.
−
**[[Core/getlanguage|Details]]**
+
−
=== getBasePath () ===
+
−
Get the base path to the website.\\
+
−
**[[Core/getbasepath|Details]]**
+
−
=== setBasePath (value) ===
+
−
Set the base path of the website. This overrides the value from the singleton method.\\
+
−
**[[Core/setbasepath|Details]]**
+
−
=== getFilePath () ===
+
−
Get the base path to files uploaded by the CMS.\\
+
−
**[[Core/getfilepath|Details]]**
+
−
=== getDownloadPath () ===
+
−
Get the base path to files uploaded by the CMS relative to the website path.\\
+
−
**[[Core/getdownloadpath|Details]]**
+
−
=== getFromCache (method, elementId, [arguments]) ===
+
−
Get the output of a method from the cache. If output doesn't exist is will call the method, cache and return the output.\\
+
−
**[[Core/getfromcache|Details]]**
+
−
=== getSetting (value) ===
+
−
Get the value of a setting in the CMS.\\
+
−
**[[Core/getsetting|Details]]**
+
−
=== useAliases (value) ===
+
−
Set wether aliases should be used or not. Using aliases has a slight performance impact.\\
+
−
**[[Core/usealiases|Details]]**
+
−
=== setDbConnection ([reInit]) ===
+
−
This method forces a reset on the internal database connection object.\\
+
−
**[[Core/setdbconnection|Details]]**
+

Latest revision as of 23:10, 25 December 2008

PunchCMS Instansiation

PCMS_Client::singleton(dsn, account, basePath)

Instansiate the singleton class. This is done only once during the execution of a page.

PCMS_Client::getInstance()

Get the CMS object instance. This way you don't have to work with a global CMS object.

PunchCMS Methods

get([elementApiName], [recursive])

Get the first element or folder with an optional specific api name from the root folder.

getElements([elementApiName], [getFirst], [recursive])

Get a collection of elements and folders with an optional specific api name from the root folder.

getFolders([elementApiName], [getFirst])

Get a collection of folders with an optional specific api name from the root folder.

getElementById(elementId)

Get an element or folder with a specific id from the CMS. If not found it will return NULL.

getFieldById(elementFieldId)

Get a field with a specific id from the CMS.

getElementByTemplate(templateApiName, [recursive], [random])

Get the first element with a specific template api name from the root folder.

getElementsByTemplate(templateApiName, [getFirst], [recursive], [random])

Get a collection of elements with a specific template api name from the root folder.

getElementByTemplateId(templateId, [recursive], [random])

Get the first element with a specific template id from the root folder.

getElementsByTemplateId(templateId, [getFirst], [recursive], [random])

Get a collection of elements with a specific template id from the root folder.

getElementsFromParent(elementId, [getFirst], [recursive])

Get a list of elements with a specific parent id.

getAliasId()

Get the element id converted from the curent URL alias.

find(query, filters, [exact], [arrAllowedTypes])

Search through the CMS using a query and optional filters.

getLanguages()

Get a collection of all active languages.

getLanguage()

Get the currently active language.

getBasePath()

Get the base path to the website.

setBasePath(value)

Set the base path of the website. This overrides the value from the singleton method.

getFilePath()

Get the base path to files uploaded by the CMS.

getDownloadPath()

Get the base path to files uploaded by the CMS relative to the website path.

getFromCache(method, elementId, [arguments])

Get the output of a method from the cache. If output doesn't exist is will call the method, cache and return the output.

getSetting(value)

Get the value of a setting in the CMS.

useAliases(value)

Set wether aliases should be used or not. Using aliases has a slight performance impact.

setDbConnection([reInit])

This method forces a reset on the internal database connection object.

Retrieved from "http://docs.punchcms.org/index.php?title=Core&oldid=71"