System Configuration
Pagination
- $config->pageNumUrlPrefix
Prefix to use in page URLs for page numbers, i.e. a prefix of 'page' would use 'page1', 'page2', etc. Default is 'page'.
Sections
- $pages
- Built-in Methods Reference
- $pages->find("selector")
- $pages->count("selector")
- $pages->get("selector")
- $pages->get(123)
- $pages->get("/path/to/page/")
- $pages->save($page)
- $pages->saveField($page, 'field')
- $pages->trash($page)
- $pages->delete($page)
- $pages->delete($page, true)
- $pages->clone($page)
- $pages->clone($page, $parent)
- $pages->clone($page, $parent, false)
- Built-in Methods Reference
- $page
- Built-in Fields Reference
- $page->id
- $page->name
- $page->title
- $page->path
- $page->url
- $page->httpUrl
- $page->parent
- $page->parentID
- $page->parents
- $page->rootParent
- $page->template
- $page->fields
- $page->numChildren
- $page->children
- $page->child
- $page->siblings
- $page->next
- $page->prev
- $page->created
- $page->modified
- $page->createdUser
- $page->modifiedUser
- Built-in Methods Reference
- $page->find($selector)
- $page->get("field")
- $page->get("field1|f2|f3")
- $page->getUnformatted("field")
- $page->setOutputFormatting(true|false)
- $page->of(true|false)
- $page->numChildren(bool)
- $page->children($selector)
- $page->child($selector)
- $page->siblings($selector)
- $page->parent($selector)
- $page->parents($selector)
- $page->parentsUntil($selector, $filter)
- $page->closest($selector)
- $page->next($pageArray)
- $page->nextAll($selector, $siblings)
- $page->nextUntil($selector, $filter, $siblings)
- $page->prev($pageArray)
- $page->prevAll($selector, $siblings)
- $page->prevUntil($selector, $filter, $siblings)
- $page->save()
- $page->save($field)
- $page->delete()
- $page->is($name)
- $page->isChanged()
- $page->isChanged("field")
- $page->isNew()
- $page->isHidden()
- $page->isTrash()
- $page->matches("selector")
- $page->render()
- $page->set("field", $value)
- $page->editable()
- $page->editable('field')
- $page->viewable()
- $page->addable()
- $page->addable($addPage)
- $page->moveable()
- $page->moveable($parent)
- $page->sortable()
- $page->deleteable()
- $page->addStatus(Page::statusHidden)
- $page->removeStatus(Page::statusHidden)
- Page Status
- Built-in Fields Reference
- PageArray/WireArray
- PageArray only
- Getting Items
- $a[$key]
- $a->$key
- $a->get($key)
- $a->find("selector")
- $a->get("selector")
- $a->getRandom()
- $a->findRandom($n)
- $a->findRandomTimed($n, $seed='Ymd')
- $a->slice($n)
- $a->slice($n, $limit)
- $a->shift()
- $a->pop()
- $a->index($n)
- $a->eq($n)
- $a->first()
- $a->last()
- $a->getNext($item)
- $a->getPrev($item)
- $a->getArray()
- $a->getKeys()
- $a->getValues()
- $a->unique()
- $a->implode([$delim], $key)
- $a->explode($key)
- $a->and($item | $items)
- Sorting and Filtering
- Setting and modifying items
- $a[] = $item
- $a->add($item)
- $a[$key] = $item
- $a->set($key, $item)
- $a->$key = $item
- $a->import($items)
- $a->prepend($item)
- $a->append($item)
- $a->insertBefore($item, $existingItem)
- $a->insertAfter($item, $existingItem)
- $a->unshift($item)
- $a->shift()
- $a->push($item)
- $a->pop()
- unset($array[$key])
- $a->remove($key)
- $a->remove($item)
- $a->removeAll()
- $a->replace($itemA, $itemB)
- Checking for items
- Change Tracking
- Miscellaneous
- Files
- $templates
- $fields
- $users
- $user
- $roles
- $permissions
- Selectors
- Built-In Page Selector Properties
- any_field=any_value
- limit=n
- sort=field
- parent=id
- parent=$page
- parent=/path/to/page/
- has_parent=/path/to/page/
- has_parent=id
- has_parent=$page
- path=/path/to/page/
- template=name
- template=$template
- start=n
- end=n
- include=all
- include=hidden
- check_access=0
- children.count=n
- created=timestamp
- modified=timestamp
- created_users_id=int
- modified_users_id=int
- Selector Operators
- Built-In Page Selector Properties
- $input
- Properties and Methods
- $input->get
- $input->get->name
- $input->get["name"]
- $input->get("name")
- $input->post
- $input->post->name
- $input->post["name"]
- $input->post("name")
- $input->cookie
- $input->cookie->name
- $input->cookie["name"]
- $input->cookie("name")
- $input->whitelist($key, $value)
- $input->whitelist($key)
- $input->urlSegments
- $input->urlSegment($n)
- $input->urlSegment1 (2,3,..)
- $input->pageNum
- Properties and Methods
- $sanitizer
- Properties and Methods
- $sanitizer->email($value)
- $sanitizer->fieldName($value)
- $sanitizer->name($value)
- $sanitizer->pageName($value)
- $sanitizer->pageName($value, true)
- $sanitizer->selectorField($value)
- $sanitizer->selectorValue($value)
- $sanitizer->text($value)
- $sanitizer->text($value, $options)
- $sanitizer->textarea($value)
- $sanitizer->textarea($value, $options)
- $sanitizer->url($value)
- $sanitizer->username($value)
- $options
- Properties and Methods
- $session
- $config
- System Configuration
- Date and Time
- Session
- File creation and identification
- Mode
- MySQL Database
- Authentication
- Pagination
- System IDs
- $config->adminRootPageID
- $config->trashPageID
- $config->loginPageID
- $config->http404PageID
- $config->usersPageID
- $config->rolesPageID
- $config->permissionsPageID
- $config->guestUserPageID
- $config->superUserPageID
- $config->guestUserRolePageID
- $config->superUserRolePageID
- $config->userTemplateID
- $config->roleTemplateID
- $config->permissionTemplateID
- Bootstrap / System