Exponent v2.7.2

storeCategory extends expNestedNode
in package

This is the class expNestedNode

Tags
subpackage

Models

Table of Contents

$attachable_items_to_save  : mixed
$attachable_table  : mixed
$classname  : mixed
$default_sort_direction  : mixed
$default_sort_field  : mixed
$do_not_validate  : mixed
$get_assoc_for  : mixed
$get_attachable_for  : mixed
$grouping_sql  : mixed
$has_and_belongs_to_many  : mixed
$has_and_belongs_to_self  : mixed
$has_extended_fields  : mixed
$has_many  : mixed
$has_many_self  : mixed
$has_one  : mixed
$identifier  : mixed
$needs_approval  : mixed
$nodes  : array<string|int, mixed>
Array of Tag Node Objects, siblings or children, depending how the class is called.
$rank_by_field  : mixed
$supports_revisions  : mixed
$table  : mixed
$tablename  : mixed
$validate  : mixed
$validates  : mixed
$attachable_item_types  : mixed
$classinfo  : mixed
__construct()  : mixed
__get()  : null
Generic magic method
__isset()  : bool
Generic magic method
__set()  : mixed
Generic magic method We MUST create/set non-existing properties for Exponent code to work
__unset()  : mixed
Generic magic method
afterCreate()  : mixed
after creating item
afterDelete()  : mixed
afterSave()  : mixed
after saving item
afterUpdate()  : mixed
after updating item
afterValidation()  : mixed
after validating item
afterValidationOnCreate()  : mixed
after validating item during creation
afterValidationOnUpdate()  : mixed
after validating item during update
associateWith()  : mixed
get objects this item belongs to ??
attachItem()  : bool
attach to item
beforeCreate()  : mixed
before creating item
beforeDelete()  : mixed
beforeSave()  : mixed
before saving item
beforeUpdate()  : mixed
before updating item
beforeValidation()  : mixed
before validating item
beforeValidationOnCreate()  : mixed
before validating item during creation
beforeValidationOnUpdate()  : mixed
before validating item during update
build()  : mixed
Adds table fields as class properties to current "record" class.
buildCategoryString()  : string
Convert nested store category into a string
buildTree()  : mixed
Modification of "Build a tree from a flat array in PHP"
create()  : mixed
delete()  : bool
delete item
displayname()  : string
name of model
find()  : array<string|int, mixed>|int|object
find an item or items
findBy()  : array<string|int, mixed>
find an item by column
findValue()  : array<string|int, mixed>|bool
find a value(s) by column
findWhereAttachedTo()  : array<string|int, mixed>
this function finds models that have this attachable item attached
getAssociatedObjects()  : null
get item's associated objects
getAttachableItemTables()  : array<string|int, mixed>
used for import/export
getBranch()  : mixed
getCategoryImage()  : string
Return an image object
getCatProducts()  : array<string|int, mixed>
Return all products assigned to this category
getCatProductsCount()  : int
Return number of products assigned to this category
getChildren()  : array<string|int, mixed>
Returns an array of individual Child Tag Objects that belong to the current "parent" tag as defined in the current class ID property.
getFirstImageId()  : mixed
getFullTree()  : mixed
getParent()  : mixed
getPoster()  : null|string
return the item poster
getSubCats()  : array<string|int, mixed>
Return all sub-categories in this category
getSubCatsCount()  : int
Get count of sub-categories in this category
getTimestamp()  : mixed
return the item timestamp
getTopLevel()  : array<string|int, mixed>
Returns an array of individual Top Level Tag Objects.
getTree()  : mixed
importCategoryString()  : int
Convert string into a nested store category
isSearchable()  : bool
is model content searchable?
makeSefUrl()  : mixed
make an sef_url for item
move()  : mixed
moveAfter()  : mixed
moveBefore()  : mixed
moveInto()  : mixed
name()  : string
name of model for backwards compat with old modules
parseCategory()  : string
Return existing store category id of string nested category checks to ensure each level of nesting exists
pathToNode()  : mixed
refresh()  : bool
re-construct the item from the database
rerank()  : mixed
rerank items
save()  : mixed
save item
saveAssociatedObjects()  : mixed
save associated objects
update()  : mixed
update item
validate()  : bool
validate item sef_url
checkForAttachableItems()  : bool
check for what objects may be attached
getAttachableItems()  : mixed
get attached objects for this item
getAssociatedObjectsForThisModel()  : mixed
gets associated objects for this model
makeManyToManyTablename()  : string
create a many to many table relationship

Properties

$attachable_items_to_save

public mixed $attachable_items_to_save

$attachable_table

public mixed $attachable_table = 'content_storeCategories'

$default_sort_direction

public mixed $default_sort_direction = ''

$default_sort_field

public mixed $default_sort_field = ''

$do_not_validate

public mixed $do_not_validate = array()

$get_assoc_for

public mixed $get_assoc_for = array()

$get_attachable_for

public mixed $get_attachable_for = array()

$grouping_sql

public mixed $grouping_sql = ''

$has_and_belongs_to_many

public mixed $has_and_belongs_to_many = array()

$has_and_belongs_to_self

public mixed $has_and_belongs_to_self = array()

$has_extended_fields

public mixed $has_extended_fields = array()

$has_many_self

public mixed $has_many_self = array()

$needs_approval

public mixed $needs_approval = \false

$nodes

Array of Tag Node Objects, siblings or children, depending how the class is called.

public array<string|int, mixed> $nodes = array()

Array of Tag Node Objects

Tags
name

$nodes

access

public

PHPUnit

Not Defined

$rank_by_field

public mixed $rank_by_field = ''

$supports_revisions

public mixed $supports_revisions = \false

$validates

public mixed $validates = array()

$attachable_item_types

protected mixed $attachable_item_types = array('content_expFiles' => 'expFile')

$classinfo

protected mixed $classinfo = \null

Methods

__construct()

public __construct([mixed $params = null ][, mixed $get_assoc = true ][, mixed $get_attached = true ]) : mixed
Parameters
$params : mixed = null
$get_assoc : mixed = true
$get_attached : mixed = true
Return values
mixed

__get()

Generic magic method

public __get( $property) : null
Parameters
$property :
Return values
null

__isset()

Generic magic method

public __isset( $property) : bool
Parameters
$property :
Return values
bool

__set()

Generic magic method We MUST create/set non-existing properties for Exponent code to work

public __set( $property,  $value) : mixed
Parameters
$property :
$value :
Return values
mixed

__unset()

Generic magic method

public __unset( $property) : mixed
Parameters
$property :
Return values
mixed

afterCreate()

after creating item

public afterCreate() : mixed
Return values
mixed

afterDelete()

public afterDelete() : mixed
Return values
mixed

afterSave()

after saving item

public afterSave() : mixed
Return values
mixed

afterUpdate()

after updating item

public afterUpdate() : mixed
Return values
mixed

afterValidation()

after validating item

public afterValidation() : mixed
Return values
mixed

afterValidationOnCreate()

after validating item during creation

public afterValidationOnCreate() : mixed
Return values
mixed

afterValidationOnUpdate()

after validating item during update

public afterValidationOnUpdate() : mixed
Return values
mixed

associateWith()

get objects this item belongs to ??

public associateWith( $datatype,  $id) : mixed

Type of associations has_and_belongs_to_many

Parameters
$datatype :
$id :
Return values
mixed

attachItem()

attach to item

public attachItem( $item[, string $subtype = '' ][, bool $replace = true ]) : bool
Parameters
$item :
$subtype : string = ''
$replace : bool = true
Return values
bool

beforeCreate()

before creating item

public beforeCreate() : mixed
Return values
mixed

beforeDelete()

public beforeDelete() : mixed
Return values
mixed

beforeSave()

before saving item

public beforeSave() : mixed
Return values
mixed

beforeUpdate()

before updating item

public beforeUpdate() : mixed
Return values
mixed

beforeValidation()

before validating item

public beforeValidation() : mixed
Return values
mixed

beforeValidationOnCreate()

before validating item during creation

public beforeValidationOnCreate() : mixed
Return values
mixed

beforeValidationOnUpdate()

before validating item during update

public beforeValidationOnUpdate() : mixed
Return values
mixed

build()

Adds table fields as class properties to current "record" class.

public build([mixed $params = array() ]) : mixed

Loads Table schema data and creates new class properties based upon the fields in given table.

Additionally, if a record ID is given, that record is pulled and field values are also populated into class properties.

Parameters
$params : mixed = array()

array or Object for table selection

Tags
category

db_record

uses

[db_type]::getDataDefinition() Builds a data definition from existing table.

requires

$db

access

protected

final
PHPUnit

Not Defined

global

object $db

Return values
mixed

buildCategoryString()

Convert nested store category into a string

public static buildCategoryString(int $catID[, bool $reset = false ]) : string
Parameters
$catID : int
$reset : bool = false
Return values
string

buildTree()

Modification of "Build a tree from a flat array in PHP"

public static buildTree(array<string|int, mixed> &$elements, mixed $parentId) : mixed

Authors: @DSkinner, @ImmortalFirefly and @SteveEdson

Parameters
$elements : array<string|int, mixed>
$parentId : mixed
Tags
link
https://stackoverflow.com/a/28429487/2078474
Return values
mixed

create()

public create(mixed $params) : mixed
Parameters
$params : mixed
Return values
mixed

delete()

delete item

public delete([string $where = '' ]) : bool
Parameters
$where : string = ''
Return values
bool

displayname()

name of model

public static displayname() : string
Return values
string

find()

find an item or items

public find([string $range = 'all' ][, null $where = null ][, null $order = null ][, null $limit = null ], int $limitstart[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>|int|object
Parameters
$range : string = 'all'

// all, revisions, first, bytitle, count, bytag, bycat,

$where : null = null
$order : null = null
$limit : null = null
$limitstart : int
$get_assoc : bool = true
$get_attached : bool = true
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
array<string|int, mixed>|int|object

findBy()

find an item by column

public findBy( $column,  $value[, bool $get_assoc = true ][, bool $get_attached = true ][, array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : array<string|int, mixed>
Parameters
$column :
$value :
$get_assoc : bool = true
$get_attached : bool = true
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
array<string|int, mixed>

findValue()

find a value(s) by column

public findValue([string $range = 'all' ][, string $column = null ][, string $where = null ][, string $order = null ][, bool $distinct = false ]) : array<string|int, mixed>|bool
Parameters
$range : string = 'all'
$column : string = null
$where : string = null
$order : string = null
$distinct : bool = false
Return values
array<string|int, mixed>|bool

findWhereAttachedTo()

this function finds models that have this attachable item attached

public findWhereAttachedTo( $content_type) : array<string|int, mixed>
Parameters
$content_type :
Return values
array<string|int, mixed>

getAssociatedObjects()

get item's associated objects

public getAssociatedObjects([object $obj = null ]) : null

Type of associations has_one has_many has_and_belongs_to_many

Parameters
$obj : object = null
Return values
null

getAttachableItemTables()

used for import/export

public getAttachableItemTables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBranch()

public getBranch([mixed $get_assoc = false ][, mixed $get_attached = false ]) : mixed
Parameters
$get_assoc : mixed = false
$get_attached : mixed = false
Return values
mixed

getCategoryImage()

Return an image object

public getCategoryImage([string $id = '' ]) : string
Parameters
$id : string = ''

specific expFile to return

Return values
string

getCatProducts()

Return all products assigned to this category

public getCatProducts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCatProductsCount()

Return number of products assigned to this category

public getCatProductsCount() : int
Return values
int

getChildren()

Returns an array of individual Child Tag Objects that belong to the current "parent" tag as defined in the current class ID property.

public getChildren([string $childName = "" ][, bool $get_assoc = false ][, bool $get_attached = false ]) : array<string|int, mixed>

Some tags may have 'child' tags, this method will access whether a "parent" Tag (as defined in the ID property of the current class instantiation) indeed has children. If so, it will wrap each child in its own Tag Object and wrap them all within a array.

If the current "parent" tag does not have children, then an empty array is created and returned.

This will *not* return "grandchildren", it is a single level query.

Parameters
$childName : string = ""

sef_url

$get_assoc : bool = false
$get_attached : bool = false
Tags
category

nested_nodes

access

public

global

object $db

Return values
array<string|int, mixed>

$children array of Child Tag Objects, empty if no children

getFirstImageId()

public getFirstImageId() : mixed
Return values
mixed

getFullTree()

public getFullTree() : mixed
Return values
mixed

getParent()

public getParent() : mixed
Return values
mixed

getPoster()

return the item poster

public getPoster([null $display = null ]) : null|string
Parameters
$display : null = null
Return values
null|string

getSubCats()

Return all sub-categories in this category

public getSubCats() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSubCatsCount()

Get count of sub-categories in this category

public getSubCatsCount() : int
Return values
int

getTimestamp()

return the item timestamp

public getTimestamp(int $type) : mixed
Parameters
$type : int
Return values
mixed

getTopLevel()

Returns an array of individual Top Level Tag Objects.

public getTopLevel([string $name = "" ][, bool $get_assoc = false ][, bool $get_attached = false ]) : array<string|int, mixed>
Parameters
$name : string = ""

sef_url

$get_assoc : bool = false
$get_attached : bool = false
Tags
category

nested_nodes

access

public

global

object $db

Return values
array<string|int, mixed>

$children array of Top Level Tag Objects, empty if no objects

getTree()

public static getTree(mixed $model_table) : mixed
Parameters
$model_table : mixed
Return values
mixed

importCategoryString()

Convert string into a nested store category

public static importCategoryString(string $data) : int
Parameters
$data : string

nested category string with :: separators

Return values
int

isSearchable()

is model content searchable?

public static isSearchable() : bool
Return values
bool

makeSefUrl()

make an sef_url for item

public makeSefUrl() : mixed
Return values
mixed

move()

public move(mixed $insertpoint[, mixed $type = "after" ]) : mixed
Parameters
$insertpoint : mixed
$type : mixed = "after"
Return values
mixed

moveAfter()

public moveAfter(mixed $target) : mixed
Parameters
$target : mixed
Return values
mixed

moveBefore()

public moveBefore(mixed $target) : mixed
Parameters
$target : mixed
Return values
mixed

moveInto()

public moveInto(mixed $target) : mixed
Parameters
$target : mixed
Return values
mixed

name()

name of model for backwards compat with old modules

public name() : string
Return values
string

parseCategory()

Return existing store category id of string nested category checks to ensure each level of nesting exists

public static parseCategory(string $data) : string
Parameters
$data : string
Return values
string

pathToNode()

public pathToNode() : mixed
Return values
mixed

refresh()

re-construct the item from the database

public refresh() : bool
Tags
throws
ReflectionException
Return values
bool

rerank()

rerank items

public rerank( $direction[, string $where = '' ]) : mixed
Parameters
$direction :
$where : string = ''
Return values
mixed

save()

save item

public save([bool $validate = false ][, bool $force_no_revisions = false ]) : mixed
Parameters
$validate : bool = false
$force_no_revisions : bool = false
Return values
mixed

saveAssociatedObjects()

save associated objects

public saveAssociatedObjects() : mixed

Type of associations has_one

Return values
mixed

update()

update item

public update([array<string|int, mixed>|object $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed>|object = array()
Return values
mixed

validate()

validate item sef_url

public validate() : bool
Return values
bool

checkForAttachableItems()

check for what objects may be attached

protected checkForAttachableItems( $params) : bool
Parameters
$params :
Return values
bool

getAttachableItems()

get attached objects for this item

protected getAttachableItems() : mixed
Return values
mixed

getAssociatedObjectsForThisModel()

gets associated objects for this model

private getAssociatedObjectsForThisModel([array<string|int, mixed> $except = array() ][, bool $cascade_except = false ]) : mixed

Type of associations has_extended_fields has_one has_many has_many_self has_and_belongs_to_many has_and_belongs_to_self

Parameters
$except : array<string|int, mixed> = array()
$cascade_except : bool = false
Return values
mixed

makeManyToManyTablename()

create a many to many table relationship

private makeManyToManyTablename( $assoc_table) : string
Parameters
$assoc_table :
Return values
string

Search results