CSPortalPortal
extends CSPortalObject
in package
Describes a Portal in the CSPortal as it is stored in the database
Tags
Table of Contents
- SHARING_TYPE_INSERTABLE = 2
- SHARING_TYPE_NONE = 0
- SHARING_TYPE_VISIBLE = 1
- SHARING_TYPE_VISIBLE_AND_INSERTABLE = 3
- $sharingFilterType : mixed
- __construct() : CSPortalObject
- Construct CSPortalObject instance.
- applySharingToSubElements() : void
- Transpose sharing to Object's children
- copyToOwner() : CSPortalPortal
- Creates a copy of a Portal including copies of the contained Tabs and Widgets
- delete() : void
- Deletes the Portal
- getCreationDate() : string
- Get creation date of object
- getCreator() : string
- Get the user name of the Object's creator
- getHeaderBackgroundColor() : string
- Get the background color of the portal
- getHeaderForegroundColor() : string
- Get the foreground color of the portal
- getHeaderLogoUrl() : string
- Get the URL of a Logo to be presented on the portal header
- getHeaderSelectedForegroundColor() : string
- Get the selected foreground color of the portal
- getID() : int
- Retrieve Record ID of current Object
- getMetaDescription() : string
- Get meta description of current Object
- getMetaKeywords() : string
- Get the meta keywords for current Object
- getModuleForTranslation() : string
- Returns a module name for which the translation should be retrieved Default: "portal"
- getOwnerID() : int
- Get UserID of current Owner
- getRubrics() : array<string|int, mixed>
- Get the rubrics set for current Object
- getSelectedTabId() : int
- Returns the Id of the current selected tab
- getSharingType() : int
- Check if current Object is shared
- getSkinFile() : string
- Retrieve path to folder containing the skin files of Portal
- getTabs() : array<string|int, mixed>
- Retrieve Tabs {@see CSPortalTab} Objects that are children of current Portal
- getThemeID() : int
- Gets the Portal Theme id
- getTitle() : string
- Get the title of the Object
- hasScopeRestriction() : bool
- Checks whether the portal is scope restricted.
- isFastPortalSwitchVisible() : bool
- Enter description here .
- isFooterVisible() : bool
- Enter description here .
- isHeaderLinksVisible() : bool
- Enter description here .
- isHelpLinkVisible() : bool
- Enter description here .
- isPortalAtLoginVisible() : bool
- Checks whether the portal is visible in the login area.
- isSearchbarVisible() : bool
- Enter description here .
- isSingleWidgetPortal() : bool
- Enter description here .
- setFastPortalSwitchVisible() : void
- Enter description here .
- setFooterVisible() : void
- Enter description here .
- setHeaderBackgroundColor() : void
- Set the background color of the portal
- setHeaderForegroundColor() : void
- Set the foreground color of the portal
- setHeaderLinksVisible() : void
- Enter description here .
- setHeaderLogoUrl() : void
- Set the header logo url of the portal
- setHeaderSelectedForegroundColor() : void
- Set the selected foreground color of the portal
- setHelpLinkVisible() : void
- Enter description here .
- setID() : void
- Set the ID of the Object
- setMetaDescription() : void
- Set the meta description of current Object
- setMetaKeywords() : void
- Set meta keywords describing current Object
- setOwnerID() : void
- Sets the OnwerID of the object
- setParentID() : void
- Move Object to another parent Object.
- setPortalAtLoginVisible() : mixed
- Sets the flag if the portal should be visible in the login area.
- setRubrics() : mixed
- Set the Rubrics for current Object with ID list of ItemRubric Records
- setScopeRestricted() : void
- Sets the portal as scope restricted.
- setSearchbarVisible() : void
- Enter description here .
- setSelectedTab() : void
- Sets the given tab as selected
- setSharingType() : void
- Set object sharing
- setSkinFile() : void
- Sets the skin folder
- setThemeID() : void
- Sets the Portal Theme id
- setTitle() : void
- Set the title of the Object
- store() : void
- Store current object to database
Constants
SHARING_TYPE_INSERTABLE
public
mixed
SHARING_TYPE_INSERTABLE
= 2
Tags
SHARING_TYPE_NONE
public
mixed
SHARING_TYPE_NONE
= 0
Tags
SHARING_TYPE_VISIBLE
public
mixed
SHARING_TYPE_VISIBLE
= 1
Tags
SHARING_TYPE_VISIBLE_AND_INSERTABLE
public
mixed
SHARING_TYPE_VISIBLE_AND_INSERTABLE
= 3
Tags
Properties
$sharingFilterType
public
static mixed
$sharingFilterType
= self::SHARING_TYPE_INSERTABLE
Tags
Methods
__construct()
Construct CSPortalObject instance.
public
__construct() : CSPortalObject
If this method is extended ensure that the object variable $this->record is set correctly.
Tags
Return values
CSPortalObject —applySharingToSubElements()
Transpose sharing to Object's children
public
final applySharingToSubElements([bool $makeAllElementsVisible = true ][, bool $applySharedWith = true ]) : void
Parameters
- $makeAllElementsVisible : bool = true
-
inherit visibility to child Objects
- $applySharedWith : bool = true
-
set access levels on children as well
Tags
Return values
void —copyToOwner()
Creates a copy of a Portal including copies of the contained Tabs and Widgets
public
copyToOwner([int $OwnerID = null ][, mixed $null = null ]) : CSPortalPortal
Parameters
- $OwnerID : int = null
-
the UserID of the new Owner, if null the current user is assumed
- $null : mixed = null
Tags
Return values
CSPortalPortal —the portal created by the copy command
delete()
Deletes the Portal
public
delete() : void
Tags
Return values
void —getCreationDate()
Get creation date of object
public
final getCreationDate() : string
Tags
Return values
string —the date when the object was created
getCreator()
Get the user name of the Object's creator
public
final getCreator() : string
Tags
Return values
string —the user name of the creator of the object
getHeaderBackgroundColor()
Get the background color of the portal
public
final getHeaderBackgroundColor() : string
Tags
Return values
string —the background color of the portal
getHeaderForegroundColor()
Get the foreground color of the portal
public
final getHeaderForegroundColor() : string
Tags
Return values
string —the foreground color of the portal
getHeaderLogoUrl()
Get the URL of a Logo to be presented on the portal header
public
final getHeaderLogoUrl() : string
Tags
Return values
string —the url absolute or relative to the admin
getHeaderSelectedForegroundColor()
Get the selected foreground color of the portal
public
final getHeaderSelectedForegroundColor() : string
Tags
Return values
string —the selected foreground color of the portal
getID()
Retrieve Record ID of current Object
public
final getID() : int
Tags
Return values
int —the id of the object
getMetaDescription()
Get meta description of current Object
public
final getMetaDescription() : string
Tags
Return values
string —the meta description of the object
getMetaKeywords()
Get the meta keywords for current Object
public
final getMetaKeywords() : string
Tags
Return values
string —the meta keywords of the object
getModuleForTranslation()
Returns a module name for which the translation should be retrieved Default: "portal"
public
final getModuleForTranslation() : string
Tags
Return values
string —getOwnerID()
Get UserID of current Owner
public
final getOwnerID() : int
Tags
Return values
int —the ID of the current Owner
getRubrics()
Get the rubrics set for current Object
public
final getRubrics() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —the rubricIDS of the object
getSelectedTabId()
Returns the Id of the current selected tab
public
getSelectedTabId() : int
Tags
Return values
int —the Id either of the last opened (stored in cookie) or first available tab
getSharingType()
Check if current Object is shared
public
final getSharingType() : int
Sharing types are:
- SHARING_TYPE_NONE (not shared) = 0
- SHARING_TYPE_VISIBLE (visible for others) = 1
- SHARING_TYPE_INSERTABLE (can be inserted in other portals) = 2
- SHARING_TYPE_VISIBLE_AND_INSERTABLE (visible to others and can be inserted) = 3
Tags
Return values
int —sharing type
getSkinFile()
Retrieve path to folder containing the skin files of Portal
public
getSkinFile() : string
Tags
Return values
string —the foldername of the portal skin
getTabs()
Retrieve Tabs {@see CSPortalTab} Objects that are children of current Portal
public
getTabs([bool $returnOnlyVisible = true ]) : array<string|int, mixed>
Parameters
- $returnOnlyVisible : bool = true
-
only visible tabs should be returned
Tags
Return values
array<string|int, mixed> —array with the CSPortalTab objects in the portal
getThemeID()
Gets the Portal Theme id
public
getThemeID() : int
Tags
Return values
int —getTitle()
Get the title of the Object
public
final getTitle([bool $translated = false ]) : string
Parameters
- $translated : bool = false
Tags
Return values
string —The title of the object
hasScopeRestriction()
Checks whether the portal is scope restricted.
public
hasScopeRestriction() : bool
Tags
Return values
bool —isFastPortalSwitchVisible()
Enter description here .
public
isFastPortalSwitchVisible() : bool
..
Tags
Return values
bool —isFooterVisible()
Enter description here .
public
isFooterVisible() : bool
..
Tags
Return values
bool —isHeaderLinksVisible()
Enter description here .
public
isHeaderLinksVisible() : bool
..
Tags
Return values
bool —isHelpLinkVisible()
Enter description here .
public
isHelpLinkVisible() : bool
..
Tags
Return values
bool —isPortalAtLoginVisible()
Checks whether the portal is visible in the login area.
public
isPortalAtLoginVisible() : bool
Tags
Return values
bool —isSearchbarVisible()
Enter description here .
public
isSearchbarVisible() : bool
..
Tags
Return values
bool —isSingleWidgetPortal()
Enter description here .
public
isSingleWidgetPortal() : bool
..
Tags
Return values
bool —setFastPortalSwitchVisible()
Enter description here .
public
setFastPortalSwitchVisible([bool $visible = true ]) : void
..
Parameters
- $visible : bool = true
Tags
Return values
void —setFooterVisible()
Enter description here .
public
setFooterVisible([bool $visible = true ]) : void
..
Parameters
- $visible : bool = true
Tags
Return values
void —setHeaderBackgroundColor()
Set the background color of the portal
public
final setHeaderBackgroundColor(mixed $sColor) : void
Parameters
- $sColor : mixed
Tags
Return values
void —setHeaderForegroundColor()
Set the foreground color of the portal
public
final setHeaderForegroundColor(mixed $sColor) : void
Parameters
- $sColor : mixed
Tags
Return values
void —setHeaderLinksVisible()
Enter description here .
public
setHeaderLinksVisible([bool $visible = true ]) : void
..
Parameters
- $visible : bool = true
Tags
Return values
void —setHeaderLogoUrl()
Set the header logo url of the portal
public
final setHeaderLogoUrl(mixed $sHeaderLogoUrl) : void
Parameters
- $sHeaderLogoUrl : mixed
Tags
Return values
void —setHeaderSelectedForegroundColor()
Set the selected foreground color of the portal
public
final setHeaderSelectedForegroundColor(mixed $sColor) : void
Parameters
- $sColor : mixed
Tags
Return values
void —setHelpLinkVisible()
Enter description here .
public
setHelpLinkVisible([bool $visible = true ]) : void
..
Parameters
- $visible : bool = true
Tags
Return values
void —setID()
Set the ID of the Object
public
final setID(int $ID) : void
Parameters
- $ID : int
-
the ID of the object
Tags
Return values
void —setMetaDescription()
Set the meta description of current Object
public
final setMetaDescription(string $description) : void
Parameters
- $description : string
-
sets the description for the object
Tags
Return values
void —setMetaKeywords()
Set meta keywords describing current Object
public
final setMetaKeywords(string $keywords) : void
Parameters
- $keywords : string
-
sets a string with blank separated keywords for the object
Tags
Return values
void —setOwnerID()
Sets the OnwerID of the object
public
final setOwnerID(int $OwnerID) : void
Parameters
- $OwnerID : int
-
the id of the new Owner
Tags
Return values
void —setParentID()
Move Object to another parent Object.
public
final setParentID(int $ID) : void
E.g. by moving a widget to a different Tab or Portal
Parameters
- $ID : int
-
the ID of the parent object
Tags
Return values
void —setPortalAtLoginVisible()
Sets the flag if the portal should be visible in the login area.
public
setPortalAtLoginVisible([bool $bIsVisible = true ]) : mixed
Parameters
- $bIsVisible : bool = true
Tags
Return values
mixed —setRubrics()
Set the Rubrics for current Object with ID list of ItemRubric Records
public
final setRubrics(array<string|int, mixed> $rubricIDs) : mixed
Parameters
- $rubricIDs : array<string|int, mixed>
-
the new rubricIDS of the object
Tags
Return values
mixed —setScopeRestricted()
Sets the portal as scope restricted.
public
final setScopeRestricted([bool $bScopeRestricted = false ]) : void
Parameters
- $bScopeRestricted : bool = false
Tags
Return values
void —setSearchbarVisible()
Enter description here .
public
setSearchbarVisible([bool $visible = true ]) : void
..
Parameters
- $visible : bool = true
Tags
Return values
void —setSelectedTab()
Sets the given tab as selected
public
setSelectedTab(int $iSelectedTabID) : void
Parameters
- $iSelectedTabID : int
-
the Id of the current selected tab
Tags
Return values
void —setSharingType()
Set object sharing
public
final setSharingType(int $sharingType) : void
Sharing types are:
- SHARING_TYPE_NONE (not shared) = 0
- SHARING_TYPE_VISIBLE (visible for others) = 1
- SHARING_TYPE_INSERTABLE (can be inserted in other portals) = 2
- SHARING_TYPE_VISIBLE_AND_INSERTABLE (visible to others and can be inserted) = 3
Parameters
- $sharingType : int
-
the CSPortal SHARING_TYPE constants
Tags
Return values
void —setSkinFile()
Sets the skin folder
public
setSkinFile(string $SkinFile) : void
Parameters
- $SkinFile : string
-
the foldername of the portal skin
Tags
Return values
void —setThemeID()
Sets the Portal Theme id
public
setThemeID(int $iThemeID) : void
Parameters
- $iThemeID : int
Tags
Return values
void —setTitle()
Set the title of the Object
public
final setTitle(string $title) : void
Parameters
- $title : string
-
the title of the object
Tags
Return values
void —store()
Store current object to database
public
final store() : void
Stores the object to the database layer