| access |
public |
| package |
kocuj_internal_lib |
| inherited_from |
\KocujIL\V12a\Classes\ComponentObject |
Methods
Constructor
__construct(object $projectObj) : void
Inherited
Parameters
$projectObj
object\KocujIL\V12a\Classes\Project object for current project
Get additional information
getAdditionalInfo() : string
Returns
stringAdditional information
Get object of class type from component
getComponent(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE, string $fragment = '') : object
Inherited
Parameters
$type
stringComponent type
$projectCategory
integerComponent category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE
$fragment
stringComponent fragment - default: empty
Returns
objectObject of class type from component
Get image filename
getImageFilename() : string
Returns
stringImage filename
Get object of type \KocujIL\V12a\Classes\Project
getProjectObj() : object
Inherited
Returns
objectObject of type \KocujIL\V12a\Classes\Project
Get object of class type for strings from component
getStrings(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE) : object
Inherited
Parameters
$type
stringComponent type
$projectCategory
integerComponent category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE
Returns
objectObject of class type for strings from component
Set additional information
setAdditionalInfo(string $additionalInfo) : void
Parameters
$additionalInfo
stringAdditional information
Set image filename
setImageFilename(string $imageFilename) : void
Parameters
$imageFilename
stringImage filename
Show page with information about plugin or theme
showPage() : void
Show links
showLinks(array $links, boolean $inline = false) : void
Parameters
$links
arrayLinks data; each link data has the following fields: "external" (bool type; if true, link will be open in new window), "link" (string type; link URL); there are available the following optional fields: "image" (string type; image filename without directory and PNG extension), "name" (string type; link name; if empty, link URL will be used as link name)
$inline
booleanLinks will be displayed in one line without text (true) or in multiple lines with text (false)
Properties
Additional information
$additionalInfo : string
Image filename
$imageFilename : string
\KocujIL\V12a\Classes\Project object for current project
$projectObj : object