Class cItemBaseAbstract

Class cItemBaseAbstract. Base class with common features for database based items and item collections.

NOTE: Because of required downwards compatibilitiy all protected/private member variables or methods don't have an leading underscore.

cGenericDb

cItemBaseAbstract

Direct known subclasses

Item, ItemCollection

Indirect known subclasses

ArticleForum, ArticleForumCollection, cApiArticleCollection, cApiShortUrlCollection, cApiStat, cApiStatCollection, cApiSystemProperty, cApiSystemPropertyCollection, cApiTemplate, cApiTemplateCollection, cApiTemplateConfiguration, cApiTemplateConfigurationCollection, cApiType, cApiArticleLanguage, cApiTypeCollection, cApiUpload, cApiUploadCollection, cApiUploadMeta, cApiUploadMetaCollection, cApiUser, cApiUserCollection, cApiUserPasswordRequest, cApiUserPasswordRequestCollection, cApiUserProperty, cApiArticleLanguageCollection, cApiUserPropertyCollection, Newsletter, NewsletterCollection, NewsletterJob, NewsletterJobCollection, NewsletterLog, NewsletterLogCollection, NewsletterRecipient, NewsletterRecipientCollection, NewsletterRecipientGroup, cApiArticleLanguageVersion, NewsletterRecipientGroupCollection, NewsletterRecipientGroupMember, NewsletterRecipientGroupMemberCollection, NoteCollection, NoteItem, PifaField, PifaFieldCollection, PifaForm, PifaFormCollection, PimPlugin, cApiArticleLanguageVersionCollection, PimPluginCollection, PimPluginRelations, PimPluginRelationsCollection, TODOCollection, TODOItem, Workflow, WorkflowAction, WorkflowActions, WorkflowAllocation, WorkflowAllocations, cApiArticleSpecification, WorkflowArtAllocation, WorkflowArtAllocations, WorkflowItem, WorkflowItems, Workflows, WorkflowTask, WorkflowTasks, WorkflowUserSequence, WorkflowUserSequences, cApiArticleSpecificationCollection, cApiCategory, cApiCategoryArticle, cApiCategoryArticleCollection, ArticleForumItem, cApiCategoryCollection, cApiCategoryLanguage, cApiCategoryLanguageCollection, cApiCategoryTree, cApiCategoryTreeCollection, cApiClient, cApiClientCollection, cApiClientLanguage, cApiClientLanguageCollection, cApiCommunication, cApiAction, cApiCommunicationCollection, cApiContainer, cApiContainerCollection, cApiContainerConfiguration, cApiContainerConfigurationCollection, cApiContent, cApiContentCollection, cApiContentVersion, cApiContentVersionCollection, cApiDbfs, cApiActionCollection, cApiDbfsCollection, cApiFile, cApiFileCollection, cApiFileInformation, cApiFileInformationCollection, cApiFrameFile, cApiFrameFileCollection, cApiFrontendGroup, cApiFrontendGroupCollection, cApiFrontendGroupMember, cApiActionlog, cApiFrontendGroupMemberCollection, cApiFrontendPermission, cApiFrontendPermissionCollection, cApiFrontendUser, cApiFrontendUserCollection, cApiGroup, cApiGroupCollection, cApiGroupMember, cApiGroupMemberCollection, cApiGroupProperty, cApiActionlogCollection, cApiGroupPropertyCollection, cApiInUse, cApiInUseCollection, cApiIso3166, cApiIso3166Collection, cApiIso6392, cApiIso6392Collection, cApiKeyword, cApiKeywordCollection, cApiLanguage, cApiArea, cApiLanguageCollection, cApiLayout, cApiLayoutCollection, cApiMailLog, cApiMailLogCollection, cApiMailLogSuccess, cApiMailLogSuccessCollection, cApiMetaTag, cApiMetaTagCollection, cApiMetaTagVersion, cApiAreaCollection, cApiMetaTagVersionCollection, cApiMetaType, cApiMetaTypeCollection, cApiModule, cApiModuleCollection, cApiNavMain, cApiNavMainCollection, cApiNavSub, cApiNavSubCollection, cApiOnlineUser, cApiArticle, cApiOnlineUserCollection, cApiPathresolveCache, cApiPathresolveCacheCollection, cApiProperty, cApiPropertyCollection, cApiRight, cApiRightCollection, cApiSearchTracking, cApiSearchTrackingCollection, cApiShortUrl

Abstract
Package: Core\GenericDB
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Murat Purc <murat@purc.de>
Located at classes/genericdb/class.item.base.abstract.php

Methods summary
`protected`	# `__construct( string $sTable, string $sPrimaryKey, string $sClassName )` Constructor to create an instance of this class. Constructor to create an instance of this class. Sets some common properties. Parameters `$sTable` `string` $sTable Name of table `$sPrimaryKey` `string` $sPrimaryKey Primary key of table `$sClassName` `string` $sClassName Name of parent class Throws `cInvalidArgumentException` If table name or primary key is not set
`protected`	# `_resetItem( )` Resets class variables back to default This is handy in case a new item is tried to be loaded into this class instance. Resets class variables back to default This is handy in case a new item is tried to be loaded into this class instance.
`public string`	# `escape( string $sString )` Escape string for using in SQL-Statement. Escape string for using in SQL-Statement. Parameters `$sString` `string` $sString The string to escape Returns `string` Escaped string
`public boolean`	# `isLoaded( )` Checks if an object is loaded If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used Checks if an object is loaded If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used Returns `boolean` Whether an object has been loaded
`protected`	# `_setLoaded( boolean $value )` Sets loaded state of class If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used Sets loaded state of class If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used Parameters `$value` `boolean` $value Whether an object is loaded
`public mixed`	# `__get( string $name )` Magic getter function for deprecated variables primaryKey and virgin This function will be removed when the variables are no longer supported Magic getter function for deprecated variables primaryKey and virgin This function will be removed when the variables are no longer supported Parameters `$name` `string` $name Name of the variable that should be accessed Returns `mixed`
`public`	# `__set( string $name, mixed $value )` Magic setter function for deprecated variables primaryKey and virgin This function will be removed when the variables are no longer supported Magic setter function for deprecated variables primaryKey and virgin This function will be removed when the variables are no longer supported Parameters `$name` `string` $name Name of the variable that should be accessed `$value` `mixed` $value Value that should be assigned to variable
`public string`	# `getPrimaryKeyName( )` Get the primary key name in database Get the primary key name in database Returns `string` Name of primary key
`protected`	# `_setPrimaryKeyName( string $keyName )` Set the primary key name for class The name must always match the primary key name in database Set the primary key name for class The name must always match the primary key name in database Parameters `$keyName` `string` $keyName
`protected cDb`	# `_getSecondDBInstance( )` Returns the second database instance, usable to run additional statements without losing current query results. Returns the second database instance, usable to run additional statements without losing current query results. Returns `cDb`
`protected cApiPropertyCollection`	# `_getPropertiesCollectionInstance( integer $idclient = 0 )` Returns properties instance, instantiates it if not done before. NOTE: This funtion changes always the client variable of property collection instance. Returns properties instance, instantiates it if not done before. NOTE: This funtion changes always the client variable of property collection instance. Parameters `$idclient` `integer` $idclient [optional] Id of client to use in property collection. If not passed it uses global variable Returns `cApiPropertyCollection`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`protected cDb`	`$db`		# Database instance, contains the database object Database instance, contains the database object
`protected cDb`	`$secondDb`		# Second DB instance, is required for some additional queries without losing an current existing query result. Second DB instance, is required for some additional queries without losing an current existing query result.
`protected cApiPropertyCollection`	`$properties`		# Property collection instance Property collection instance
`protected cItemCache`	`$_oCache`		# Item cache instance Item cache instance
`protected array`	`$_settings`		# GenericDB settings, see $cfg['sql'] GenericDB settings, see $cfg['sql']
`protected string`	`$table`		# Storage of the source table to use for the information Storage of the source table to use for the information
`private string`	`$primaryKey`		# Setting of primaryKey name (deprecated) Setting of primaryKey name (deprecated) Deprecated [2015-05-04] Class variable primaryKey is deprecated, use getPrimaryKeyName() instead
`protected string`	`$_primaryKeyName`		# Storage of the primary key name Storage of the primary key name
`private boolean`	`$virgin`	`true`	# Checks for the virginity of created objects. If true, the object is virgin and no operations on it except load-functions are allowed. Checks for the virginity of created objects. If true, the object is virgin and no operations on it except load-functions are allowed. Deprecated [2015-05-05] Class variable virgin is deprecated, use negated result of isLoaded() instead
`protected boolean`	`$_loaded`	`false`	# Checks if an object is loaded If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used Checks if an object is loaded If it is true an object is loaded If it is false then no object is loaded and only load-functions are allowed to be used
`protected string`	`$lasterror`	`''`	# Storage of the last occured error Storage of the last occured error
`protected string`	`$_className`		# Classname of current instance Classname of current instance

Packages

Classes

Class cItemBaseAbstract

Direct known subclasses

Indirect known subclasses

Parameters

Throws

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Deprecated