Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • ActionLog
  • ActiveRecord
  • ActiveRecordProviderMySQL
  • ActiveRecordProviderSQLite
  • Article
  • ArticleComment
  • ArticleVote
  • BadRequest
  • BlacklistedClient
  • BlacklistedIP
  • Person
  • Rights
  • Tag

Interfaces

  • ActiveRecordProviderInterface

Class Rights

The group level rights object for the application permissions.

Alpha\Model\ActiveRecord
Extended by Alpha\Model\Rights
Namespace: Alpha\Model
Copyright:

Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Model/Rights.php

Methods summary

public
# __construct( )

Constructor.

Constructor.

Since

1.0

Overrides

Alpha\Model\ActiveRecord::__construct
public Alpha\Model\Type\Relation
# getMembers( )

Get the group members Relation.

Get the group members Relation.

Returns

Alpha\Model\Type\Relation

Since

1.0
protected
# after_load_callback( )

Set up the transient attributes for the rights group after it has loaded.

Set up the transient attributes for the rights group after it has loaded.

Since

1.0
protected
# after_save_callback( )

Set up the transient attributes for the rights group after it has been created.

Set up the transient attributes for the rights group after it has been created.

Since

1.2.1
protected
# after_loadByAttribute_callback( )

Set up the transient attributes for the rights group after it has loaded.

Set up the transient attributes for the rights group after it has loaded.

Since

1.0
protected
# setupRels( )

Sets up the Relation definitions on this record.

Sets up the Relation definitions on this record.

Since

1.0

Methods inherited from Alpha\Model\ActiveRecord

__wakeup(), addProperty(), addToCache(), backupDatabase(), begin(), cast(), checkDatabaseExists(), checkRecordExists(), checkRecordTableExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createDatabase(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropDatabase(), dropTable(), findMissingFields(), get(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getPersistentAttributes(), getPropObject(), getRecordClassNames(), getTableName(), getTaggedAttributes(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadAllOldVersions(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromArray(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), saveRelations(), set(), setDataLabels(), setEnumOptions(), setID(), setLastQuery(), setMaintainHistory(), toArray(), validate()

Constants summary

string TABLE_NAME

The name of the database table for the class.

The name of the database table for the class.

Since

1.0
# 'Rights'

Properties summary

protected Alpha\Model\Type\SmallText $name

The name of the rights.

The name of the rights.

Since

1.0
#
protected Alpha\Model\Type\Relation $members

A Relation containing all of the Person objects that have these rights.

A Relation containing all of the Person objects that have these rights.

Since

1.0
#
protected array $dataLabels

An array of data display labels for the class properties.

An array of data display labels for the class properties.

Since

1.0
# array('ID' => 'Rights Group ID#', 'name' => 'Rights Group Name', 'members' => 'Rights Group Members')

Properties inherited from Alpha\Model\ActiveRecord

$ID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num

Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen